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.81 2006/09/06 13:03:04 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 - 2004 the SourceForge
  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  * Revisions   :
  39  *    $Log: project.h,v $
  40  *    Revision 1.81  2006/09/06 13:03:04  fabiankeil
  41  *    Respond with 400 and a short text message
  42  *    if the client tries to use Privoxy as FTP proxy.
  43  *
  44  *    Revision 1.80  2006/09/06 10:43:32  fabiankeil
  45  *    Added config option enable-remote-http-toggle
  46  *    to specify if Privoxy should recognize special
  47  *    headers (currently only X-Filter) to change its
  48  *    behaviour. Disabled by default.
  49  *
  50  *    Revision 1.79  2006/09/06 09:23:37  fabiankeil
  51  *    Make number of retries in case of forwarded-connect problems
  52  *    a config file option (forwarded-connect-retries) and use 0 as
  53  *    default.
  54  *
  55  *    Revision 1.78  2006/08/31 16:25:06  fabiankeil
  56  *    Work around a buffer overflow that caused Privoxy to
  57  *    segfault if too many trusted referrers were used. Good
  58  *    enough for now, but should be replaced with a real
  59  *    solution after the next release.
  60  *
  61  *    Revision 1.77  2006/08/21 12:50:51  david__schmidt
  62  *    Formatting cleanup
  63  *
  64  *    Revision 1.76  2006/08/14 08:25:19  fabiankeil
  65  *    Split filter-headers{} into filter-client-headers{}
  66  *    and filter-server-headers{}.
  67  *    Added parse_header_time() to share some code.
  68  *    Replaced timegm() with mktime().
  69  *
  70  *    Revision 1.75  2006/08/03 02:46:41  david__schmidt
  71  *    Incorporate Fabian Keil's patch work:\r *    http://www.fabiankeil.de/sourcecode/privoxy/
  72  *
  73  *    Revision 1.74  2006/07/18 14:48:47  david__schmidt
  74  *    Reorganizing the repository: swapping out what was HEAD (the old 3.1 branch)
  75  *    with what was really the latest development (the v_3_0_branch branch)
  76  *
  77  *    Revision 1.72.2.7  2006/01/29 23:10:56  david__schmidt
  78  *    Multiple filter file support
  79  *
  80  *    Revision 1.72.2.6  2004/10/03 12:53:46  david__schmidt
  81  *    Add the ability to check jpeg images for invalid
  82  *    lengths of comment blocks.  Defensive strategy
  83  *    against the exploit:
  84  *       Microsoft Security Bulletin MS04-028
  85  *       Buffer Overrun in JPEG Processing (GDI+) Could
  86  *       Allow Code Execution (833987)
  87  *    Enabled with +inspect-jpegs in actions files.
  88  *
  89  *    Revision 1.72.2.5  2004/01/30 15:29:29  oes
  90  *    Updated the copyright note
  91  *
  92  *    Revision 1.72.2.4  2004/01/13 16:12:14  oes
  93  *    Fixed double slash in USER_MANUAL_URL. Closes BR #867088.
  94  *
  95  *    Revision 1.72.2.3  2003/03/11 11:54:37  oes
  96  *    Introduced RC_FLAG_* flags for use in child process return code
  97  *
  98  *    Revision 1.72.2.2  2002/11/28 18:15:44  oes
  99  *    Added flag to each cgi_dispatcher that allows or denies
 100  *    external linking and removed const qualifier from
 101  *    struct list_entry.str.
 102  *
 103  *    Revision 1.72.2.1  2002/08/10 11:25:18  oes
 104  *    - Include config.h for access to config data
 105  *    - Include <pcre*.h> depending on where they are
 106  *
 107  *    Revision 1.72  2002/05/14 21:35:49  oes
 108  *    Split HELP_LINK_PREFIX into ACTIONS_HELP_PREFIX and CONFIG_HELP_PREFIX
 109  *    because of split in user-manual
 110  *
 111  *    Revision 1.71  2002/05/12 21:39:36  jongfoster
 112  *    - Adding Doxygen-style comments to structures and #defines.
 113  *
 114  *    Revision 1.70  2002/05/12 16:05:50  jongfoster
 115  *    Fixing ACTION_MASK_ALL to be unsigned long rather than
 116  *    just unsigned int.  I don't know if anyone is porting
 117  *    Privoxy to 16-bit platforms, but if so, +limit-connect
 118  *    wouldn't have worked because of this bug.
 119  *
 120  *    Revision 1.69  2002/05/08 16:00:16  oes
 121  *    Added size member to struct iob, so it can
 122  *    be alloced larger than needed.
 123  *
 124  *    Revision 1.68  2002/04/26 12:56:00  oes
 125  *    Killed REDIRECT_URL, added USER_MANUAL_URL and HELP_LINK_PREFIX
 126  *
 127  *    Revision 1.67  2002/04/24 02:12:43  oes
 128  *     - Jon's multiple AF patch:
 129  *       - Make csp->actions_list an array
 130  *       - #define MAX_AF_FILES
 131  *     - Moved CGI_PARAM_LEN_MAX (500) here
 132  *
 133  *    Revision 1.66  2002/04/15 19:06:43  jongfoster
 134  *    Typos
 135  *
 136  *    Revision 1.65  2002/04/04 00:36:36  gliptak
 137  *    always use pcre for matching
 138  *
 139  *    Revision 1.64  2002/04/03 22:28:03  gliptak
 140  *    Removed references to gnu_regex
 141  *
 142  *    Revision 1.63  2002/03/31 17:19:00  jongfoster
 143  *    Win32 only: Enabling STRICT to fix a VC++ compile warning.
 144  *
 145  *    Revision 1.62  2002/03/26 22:48:49  swa
 146  *    new homepage url
 147  *
 148  *    Revision 1.61  2002/03/26 22:29:55  swa
 149  *    we have a new homepage!
 150  *
 151  *    Revision 1.60  2002/03/24 15:52:17  jongfoster
 152  *    Changing CGI URL prefixes for new name
 153  *
 154  *    Revision 1.59  2002/03/24 15:23:33  jongfoster
 155  *    Name changes
 156  *
 157  *    Revision 1.58  2002/03/24 13:25:43  swa
 158  *    name change related issues
 159  *
 160  *    Revision 1.57  2002/03/16 20:28:34  oes
 161  *    Added descriptions to the filters so users will know what they select in the cgi editor
 162  *
 163  *    Revision 1.56  2002/03/13 20:27:30  oes
 164  *    Fixing bug with CT_TABOO
 165  *
 166  *    Revision 1.55  2002/03/12 01:42:50  oes
 167  *    Introduced modular filters
 168  *
 169  *    Revision 1.54  2002/03/09 20:03:52  jongfoster
 170  *    - Making various functions return int rather than size_t.
 171  *      (Undoing a recent change).  Since size_t is unsigned on
 172  *      Windows, functions like read_socket that return -1 on
 173  *      error cannot return a size_t.
 174  *
 175  *      THIS WAS A MAJOR BUG - it caused frequent, unpredictable
 176  *      crashes, and also frequently caused JB to jump to 100%
 177  *      CPU and stay there.  (Because it thought it had just
 178  *      read ((unsigned)-1) == 4Gb of data...)
 179  *
 180  *    - The signature of write_socket has changed, it now simply
 181  *      returns success=0/failure=nonzero.
 182  *
 183  *    - Trying to get rid of a few warnings --with-debug on
 184  *      Windows, I've introduced a new type "jb_socket".  This is
 185  *      used for the socket file descriptors.  On Windows, this
 186  *      is SOCKET (a typedef for unsigned).  Everywhere else, it's
 187  *      an int.  The error value can't be -1 any more, so it's
 188  *      now JB_INVALID_SOCKET (which is -1 on UNIX, and in
 189  *      Windows it maps to the #define INVALID_SOCKET.)
 190  *
 191  *    - The signature of bind_port has changed.
 192  *
 193  *    Revision 1.53  2002/03/08 16:48:55  oes
 194  *    Added FEATURE_NO_GIFS and BUILTIN_IMAGE_MIMETYPE
 195  *
 196  *    Revision 1.52  2002/03/07 03:46:17  oes
 197  *    Fixed compiler warnings
 198  *
 199  *    Revision 1.51  2002/03/05 04:52:42  oes
 200  *    Deleted non-errlog debugging code
 201  *
 202  *    Revision 1.50  2002/03/04 19:32:07  oes
 203  *    Changed default port to 8118
 204  *
 205  *    Revision 1.49  2002/03/04 18:28:55  oes
 206  *    Deleted PID_FILE_NAME
 207  *
 208  *    Revision 1.48  2002/03/03 14:50:40  oes
 209  *    Fixed CLF logging: Added ocmd member for client's request to struct http_request
 210  *
 211  *    Revision 1.47  2002/02/20 23:15:13  jongfoster
 212  *    Parsing functions now handle out-of-memory gracefully by returning
 213  *    an error code.
 214  *
 215  *    Revision 1.46  2002/01/17 21:06:09  jongfoster
 216  *    Now #defining the URLs of the config interface
 217  *
 218  *    Minor changes to struct http_request and struct url_spec due to
 219  *    standardizing that struct http_request is used to represent a URL, and
 220  *    struct url_spec is used to represent a URL pattern.  (Before, URLs were
 221  *    represented as seperate variables and a partially-filled-in url_spec).
 222  *
 223  *    Revision 1.45  2002/01/09 14:33:27  oes
 224  *    Added HOSTENT_BUFFER_SIZE
 225  *
 226  *    Revision 1.44  2001/12/30 14:07:32  steudten
 227  *    - Add signal handling (unix)
 228  *    - Add SIGHUP handler (unix)
 229  *    - Add creation of pidfile (unix)
 230  *    - Add action 'top' in rc file (RH)
 231  *    - Add entry 'SIGNALS' to manpage
 232  *    - Add exit message to logfile (unix)
 233  *
 234  *    Revision 1.43  2001/11/22 21:57:51  jongfoster
 235  *    Making action_spec->flags into an unsigned long rather than just an
 236  *    unsigned int.
 237  *    Adding ACTION_NO_COOKIE_KEEP
 238  *
 239  *    Revision 1.42  2001/11/05 21:42:41  steudten
 240  *    Include DBG() macro.
 241  *
 242  *    Revision 1.41  2001/10/28 19:12:06  jongfoster
 243  *    Adding ijb_toupper()
 244  *
 245  *    Revision 1.40  2001/10/26 17:40:47  oes
 246  *    Moved ijb_isspace and ijb_tolower to project.h
 247  *    Removed http->user_agent, csp->referrer and csp->accept_types
 248  *
 249  *    Revision 1.39  2001/10/25 03:45:02  david__schmidt
 250  *    Adding a (void*) cast to freez() because Visual Age C++ won't expand the
 251  *    macro when called with a cast; so moving the cast to the macro def'n
 252  *    seems to both eliminate compiler warnings (on darwin and OS/2, anyway) and
 253  *    doesn't make macro expansion complain.  Hope this works for everyone else
 254  *    too...
 255  *
 256  *    Revision 1.38  2001/10/23 21:19:04  jongfoster
 257  *    New error-handling support: jb_err type and JB_ERR_xxx constants
 258  *    CGI functions now return a jb_err, and their parameters map is const.
 259  *    Support for RUNTIME_FEATUREs to enable/disable config editor
 260  *    Adding a few comments
 261  *
 262  *    Revision 1.37  2001/10/14 22:14:01  jongfoster
 263  *    Removing name_length field from struct cgi_dispatcher, as this is
 264  *    now calculated at runtime from the "name" field.
 265  *
 266  *    Revision 1.36  2001/10/10 16:45:15  oes
 267  *    Added LIMIT_CONNECT action and string
 268  *    Fixed HTTP message line termination
 269  *    Added CFORBIDDEN HTTP message
 270  *
 271  *    Revision 1.35  2001/10/07 18:06:43  oes
 272  *    Added status member to struct http_request
 273  *
 274  *    Revision 1.34  2001/10/07 15:45:25  oes
 275  *    Added url member to struct http_request and commented all
 276  *      members
 277  *
 278  *    Added CT_TABOO
 279  *
 280  *    Added ACTION_DOWNGRADE and ACTION_NO_COMPRESSION
 281  *
 282  *    Replaced struct client_state members rejected,
 283  *      force, active and toggled_on with "flags" bitmap.
 284  *
 285  *    Added CSP_FLAG_MODIFIED and CSP_FLAG_CHUNKED
 286  *
 287  *    Added buffer_limit to struct configuration_spec
 288  *
 289  *    Revision 1.33  2001/09/20 13:30:08  steudten
 290  *
 291  *    Make freez() more secure in case of: if (exp) { free(z) ; a=*z }
 292  *    Last case will set z to NULL in free(z) and thats bad..
 293  *
 294  *    Revision 1.32  2001/09/16 23:02:51  jongfoster
 295  *    Fixing warning
 296  *
 297  *    Revision 1.31  2001/09/16 13:20:29  jongfoster
 298  *    Rewrite of list library.  Now has seperate header and list_entry
 299  *    structures.  Also added a large sprinking of assert()s to the list
 300  *    code.
 301  *
 302  *    Revision 1.30  2001/09/13 23:52:00  jongfoster
 303  *    Support for both static and dynamically generated CGI pages
 304  *
 305  *    Revision 1.29  2001/09/13 23:29:43  jongfoster
 306  *    Defining FORWARD_SPEC_INITIALIZER
 307  *
 308  *    Revision 1.28  2001/09/13 23:05:50  jongfoster
 309  *    Changing the string paramater to the header parsers a "const".
 310  *
 311  *    Revision 1.27  2001/08/05 16:06:20  jongfoster
 312  *    Modifiying "struct map" so that there are now separate header and
 313  *    "map_entry" structures.  This means that functions which modify a
 314  *    map no longer need to return a pointer to the modified map.
 315  *    Also, it no longer reverses the order of the entries (which may be
 316  *    important with some advanced template substitutions).
 317  *
 318  *    Revision 1.26  2001/07/30 22:08:36  jongfoster
 319  *    Tidying up #defines:
 320  *    - All feature #defines are now of the form FEATURE_xxx
 321  *    - Permanently turned off WIN_GUI_EDIT
 322  *    - Permanently turned on WEBDAV and SPLIT_PROXY_ARGS
 323  *
 324  *    Revision 1.25  2001/07/29 18:43:08  jongfoster
 325  *    Changing #ifdef _FILENAME_H to FILENAME_H_INCLUDED, to conform to
 326  *    ANSI C rules.
 327  *
 328  *    Revision 1.24  2001/07/25 17:20:27  oes
 329  *    Introduced http->user_agent
 330  *
 331  *    Revision 1.23  2001/07/18 12:32:23  oes
 332  *    - Added ACTION_STRING_DEANIMATE
 333  *    - moved #define freez from jcc.h to project.h
 334  *
 335  *    Revision 1.22  2001/07/15 17:51:41  jongfoster
 336  *    Renaming #define STATIC to STATIC_PCRE
 337  *
 338  *    Revision 1.21  2001/07/13 14:03:19  oes
 339  *     - Reorganized regex header inclusion and #defines to
 340  *       comply to the scheme in configure.in
 341  *     - Added csp->content_type and its CT_* keys
 342  *     - Added ACTION_DEANIMATE
 343  *     - Removed all #ifdef PCRS
 344  *
 345  *    Revision 1.20  2001/06/29 21:45:41  oes
 346  *    Indentation, CRLF->LF, Tab-> Space
 347  *
 348  *    Revision 1.19  2001/06/29 13:33:36  oes
 349  *    - Improved comments
 350  *    - Introduced http_request.host_ip_addr_str
 351  *    - Introduced http_response.head_length
 352  *    - Introduced config.my_ip_addr_str, config.my_hostname,
 353  *      config.admin_address and config.proxy_info_url
 354  *    - Removed config.proxy_args_header and config.proxy_args_trailer,
 355  *      renamed config.proxy_args_invocation to config.proxy_args
 356  *    - Removed HTML snipplets and GIFs
 357  *    - Removed logentry from cancelled commit
 358  *
 359  *    Revision 1.18  2001/06/09 10:57:39  jongfoster
 360  *    Adding definition of BUFFER_SIZE.
 361  *    Changing struct cgi_dispatcher to use "const" strings.
 362  *
 363  *    Revision 1.17  2001/06/07 23:15:09  jongfoster
 364  *    Merging ACL and forward files into config file.
 365  *    Moving struct gateway members into struct forward_spec
 366  *    Removing config->proxy_args_gateways
 367  *    Cosmetic: Adding a few comments
 368  *
 369  *    Revision 1.16  2001/06/04 18:31:58  swa
 370  *    files are now prefixed with either `confdir' or `logdir'.
 371  *    `make redhat-dist' replaces both entries confdir and logdir
 372  *    with redhat values
 373  *
 374  *    Revision 1.15  2001/06/04 11:28:53  swa
 375  *    redirect did not work due to missing /
 376  *
 377  *    Revision 1.14  2001/06/03 11:03:48  oes
 378  *    Added struct map,
 379  *    added struct http_response,
 380  *    changed struct interceptors to struct cgi_dispatcher,
 381  *    moved HTML stuff to cgi.h
 382  *
 383  *    Revision 1.13  2001/06/01 20:05:36  jongfoster
 384  *    Support for +image-blocker{}: added ACTION_IMAGE_BLOCKER
 385  *    constant, and removed csp->tinygif.
 386  *
 387  *    Revision 1.12  2001/06/01 18:49:17  jongfoster
 388  *    Replaced "list_share" with "list" - the tiny memory gain was not
 389  *    worth the extra complexity.
 390  *
 391  *    Revision 1.11  2001/06/01 10:32:47  oes
 392  *    Added constants for anchoring selection bitmap
 393  *
 394  *    Revision 1.10  2001/05/31 21:33:53  jongfoster
 395  *    Changes for new actions file, replacing permissionsfile
 396  *    and parts of the config file.  Also added support for
 397  *    list_shared.
 398  *
 399  *    Revision 1.9  2001/05/31 17:32:31  oes
 400  *
 401  *     - Enhanced domain part globbing with infix and prefix asterisk
 402  *       matching and optional unanchored operation
 403  *
 404  *    Revision 1.8  2001/05/29 20:09:15  joergs
 405  *    HTTP_REDIRECT_TEMPLATE fixed.
 406  *
 407  *    Revision 1.7  2001/05/29 09:50:24  jongfoster
 408  *    Unified blocklist/imagelist/actionslist.
 409  *    File format is still under discussion, but the internal changes
 410  *    are (mostly) done.
 411  *
 412  *    Also modified interceptor behaviour:
 413  *    - We now intercept all URLs beginning with one of the following
 414  *      prefixes (and *only* these prefixes):
 415  *        * http://i.j.b/
 416  *        * http://ijbswa.sf.net/config/
 417  *        * http://ijbswa.sourceforge.net/config/
 418  *    - New interceptors "home page" - go to http://i.j.b/ to see it.
 419  *    - Internal changes so that intercepted and fast redirect pages
 420  *      are not replaced with an image.
 421  *    - Interceptors now have the option to send a binary page direct
 422  *      to the client. (i.e. ijb-send-banner uses this)
 423  *    - Implemented show-url-info interceptor.  (Which is why I needed
 424  *      the above interceptors changes - a typical URL is
 425  *      "http://i.j.b/show-url-info?url=www.somesite.com/banner.gif".
 426  *      The previous mechanism would not have intercepted that, and
 427  *      if it had been intercepted then it then it would have replaced
 428  *      it with an image.)
 429  *
 430  *    Revision 1.6  2001/05/27 22:17:04  oes
 431  *
 432  *    - re_process_buffer no longer writes the modified buffer
 433  *      to the client, which was very ugly. It now returns the
 434  *      buffer, which it is then written by chat.
 435  *
 436  *    - content_length now adjusts the Content-Length: header
 437  *      for modified documents rather than crunch()ing it.
 438  *      (Length info in csp->content_length, which is 0 for
 439  *      unmodified documents)
 440  *
 441  *    - For this to work, sed() is called twice when filtering.
 442  *
 443  *    Revision 1.5  2001/05/26 00:28:36  jongfoster
 444  *    Automatic reloading of config file.
 445  *    Removed obsolete SIGHUP support (Unix) and Reload menu option (Win32).
 446  *    Most of the global variables have been moved to a new
 447  *    struct configuration_spec, accessed through csp->config->globalname
 448  *    Most of the globals remaining are used by the Win32 GUI.
 449  *
 450  *    Revision 1.4  2001/05/22 18:46:04  oes
 451  *
 452  *    - Enabled filtering banners by size rather than URL
 453  *      by adding patterns that replace all standard banner
 454  *      sizes with the "Junkbuster" gif to the re_filterfile
 455  *
 456  *    - Enabled filtering WebBugs by providing a pattern
 457  *      which kills all 1x1 images
 458  *
 459  *    - Added support for PCRE_UNGREEDY behaviour to pcrs,
 460  *      which is selected by the (nonstandard and therefore
 461  *      capital) letter 'U' in the option string.
 462  *      It causes the quantifiers to be ungreedy by default.
 463  *      Appending a ? turns back to greedy (!).
 464  *
 465  *    - Added a new interceptor ijb-send-banner, which
 466  *      sends back the "Junkbuster" gif. Without imagelist or
 467  *      MSIE detection support, or if tinygif = 1, or the
 468  *      URL isn't recognized as an imageurl, a lame HTML
 469  *      explanation is sent instead.
 470  *
 471  *    - Added new feature, which permits blocking remote
 472  *      script redirects and firing back a local redirect
 473  *      to the browser.
 474  *      The feature is conditionally compiled, i.e. it
 475  *      can be disabled with --disable-fast-redirects,
 476  *      plus it must be activated by a "fast-redirects"
 477  *      line in the config file, has its own log level
 478  *      and of course wants to be displayed by show-proxy-args
 479  *      Note: Boy, all the #ifdefs in 1001 locations and
 480  *      all the fumbling with configure.in and acconfig.h
 481  *      were *way* more work than the feature itself :-(
 482  *
 483  *    - Because a generic redirect template was needed for
 484  *      this, tinygif = 3 now uses the same.
 485  *
 486  *    - Moved GIFs, and other static HTTP response templates
 487  *      to project.h
 488  *
 489  *    - Some minor fixes
 490  *
 491  *    - Removed some >400 CRs again (Jon, you really worked
 492  *      a lot! ;-)
 493  *
 494  *    Revision 1.3  2001/05/20 01:21:20  jongfoster
 495  *    Version 2.9.4 checkin.
 496  *    - Merged popupfile and cookiefile, and added control over PCRS
 497  *      filtering, in new "actionsfile".
 498  *    - Implemented LOG_LEVEL_FATAL, so that if there is a configuration
 499  *      file error you now get a message box (in the Win32 GUI) rather
 500  *      than the program exiting with no explanation.
 501  *    - Made killpopup use the PCRS MIME-type checking and HTTP-header
 502  *      skipping.
 503  *    - Removed tabs from "config"
 504  *    - Moved duplicated url parsing code in "loaders.c" to a new funcition.
 505  *    - Bumped up version number.
 506  *
 507  *    Revision 1.2  2001/05/17 23:01:01  oes
 508  *     - Cleaned CRLF's from the sources and related files
 509  *
 510  *    Revision 1.1.1.1  2001/05/15 13:59:03  oes
 511  *    Initial import of version 2.9.3 source tree
 512  *
 513  *
 514  *********************************************************************/
 515 \f
 516
 517 /* Declare struct FILE for vars and funcs. */
 518 #include <stdio.h>
 519
 520 /* Need time_t for file_list */
 521 #include <time.h>
 522 /* Needed for pcre choice */
 523 #include "config.h"
 524
 525 /*
 526  * Include appropriate regular expression libraries.
 527  * Note that pcrs and pcre (native) are needed for cgi
 528  * and are included anyway.
 529  */
 530
 531 #ifdef STATIC_PCRE
 532 #  include "pcre.h"
 533 #else
 534 #  ifdef PCRE_H_IN_SUBDIR
 535 #    include <pcre/pcre.h>
 536 #  else
 537 #    include <pcre.h>
 538 #  endif
 539 #endif
 540
 541 #ifdef STATIC_PCRS
 542 #  include "pcrs.h"
 543 #else
 544 #  include <pcrs.h>
 545 #endif
 546
 547 #ifdef STATIC_PCRE
 548 #  include "pcreposix.h"
 549 #else
 550 #  ifdef PCRE_H_IN_SUBDIR
 551 #    include <pcre/pcreposix.h>
 552 #  else
 553 #    include <pcreposix.h>
 554 #  endif
 555 #endif
 556
 557 #ifdef AMIGA
 558 #include "amiga.h"
 559 #endif /* def AMIGA */
 560
 561 #ifdef _WIN32
 562 /*
 563  * I don't want to have to #include all this just for the declaration
 564  * of SOCKET.  However, it looks like we have to...
 565  */
 566 #ifndef STRICT
 567 #define STRICT
 568 #endif
 569 #include <windows.h>
 570 #endif
 571
 572
 573 #ifdef __cplusplus
 574 extern "C" {
 575 #endif
 576
 577 #ifdef _WIN32
 578
 579 typedef SOCKET jb_socket;
 580
 581 #define JB_INVALID_SOCKET INVALID_SOCKET
 582
 583 #else /* ndef _WIN32 */
 584
 585 /**
 586  * The type used by sockets.  On UNIX it's an int.  Microsoft decided to
 587  * make it an unsigned.
 588  */
 589 typedef int jb_socket;
 590
 591 /**
 592  * The error value used for variables of type jb_socket.  On UNIX this
 593  * is -1, however Microsoft decided to make socket handles unsigned, so
 594  * they use a different value.
 595  */
 596
 597 #define JB_INVALID_SOCKET (-1)
 598
 599 #endif /* ndef _WIN32 */
 600
 601
 602 /**
 603  * A standard error code.  This should be JB_ERR_OK or one of the JB_ERR_xxx
 604  * series of errors.
 605  */
 606 typedef int jb_err;
 607
 608 #define JB_ERR_OK         0 /**< Success, no error                        */
 609 #define JB_ERR_MEMORY     1 /**< Out of memory                            */
 610 #define JB_ERR_CGI_PARAMS 2 /**< Missing or corrupt CGI parameters        */
 611 #define JB_ERR_FILE       3 /**< Error opening, reading or writing a file */
 612 #define JB_ERR_PARSE      4 /**< Error parsing file                       */
 613 #define JB_ERR_MODIFIED   5 /**< File has been modified outside of the
 614                                  CGI actions editor.                      */
 615
 616
 617 /**
 618  * This macro is used to free a pointer that may be NULL.
 619  * It also sets the variable to NULL after it's been freed.
 620  * The paramater should be a simple variable without side effects.
 621  */
 622 #define freez(X)  { if(X) { free((void*)X); X = NULL ; } }
 623
 624
 625 /**
 626  * Fix a problem with Solaris.  There should be no effect on other
 627  * platforms.
 628  *
 629  * Solaris's isspace() is a macro which uses it's argument directly
 630  * as an array index.  Therefore we need to make sure that high-bit
 631  * characters generate +ve values, and ideally we also want to make
 632  * the argument match the declared parameter type of "int".
 633  *
 634  * Note: Remember to #include <ctype.h> if you use these macros.
 635  */
 636 #define ijb_toupper(__X) toupper((int)(unsigned char)(__X))
 637 #define ijb_tolower(__X) tolower((int)(unsigned char)(__X))
 638 #define ijb_isspace(__X) isspace((int)(unsigned char)(__X))
 639
 640 /**
 641  * Use for statically allocated buffers if you have no other choice.
 642  * Remember to check the length of what you write into the buffer
 643  * - we don't want any buffer overflows!
 644  */
 645 #define BUFFER_SIZE 5000
 646
 647 /**
 648  * Max length of CGI parameters (arbitrary limit).
 649  */
 650 #define CGI_PARAM_LEN_MAX 500
 651
 652 /**
 653  * Buffer size for capturing struct hostent data in the
 654  * gethostby(name|addr)_r library calls. Since we don't
 655  * loop over gethostbyname_r, the buffer must be sufficient
 656  * to accomodate multiple IN A RRs, as used in DNS round robin
 657  * load balancing. W3C's wwwlib uses 1K, so that should be
 658  * good enough for us, too.
 659  */
 660 /**
 661  * XXX: Temporary doubled, for some configurations
 662  * 1K is still too small and we didn't get the
 663  * real fix ready for inclusion.
 664  */
 665 #define HOSTENT_BUFFER_SIZE 2048
 666
 667 /**
 668  * Do not use.  Originally this was so that you can
 669  * say "while (FOREVER) { ...do something... }".
 670  * However, this gives a warning with some compilers (e.g. VC++).
 671  * Instead, use "for (;;) { ...do something... }".
 672  */
 673 #define FOREVER 1
 674
 675 /**
 676  * Default IP address to listen on, as a string.
 677  * Set to "127.0.0.1".
 678  */
 679 #define HADDR_DEFAULT   "127.0.0.1"
 680
 681 /**
 682  * Default port to listen on, as a number.
 683  * Set to 8118.
 684  */
 685 #define HADDR_PORT      8118
 686
 687
 688 /* Forward def for struct client_state */
 689 struct configuration_spec;
 690
 691
 692 /**
 693  * Entry in a linked list of strings.
 694  */
 695 struct list_entry
 696 {
 697    /**
 698     * The string pointer. It must point to a dynamically malloc()ed
 699     * string or be NULL for the list functions to work. In the latter
 700     * case, just be careful next time you iterate through the list in
 701     * your own code.
 702     */
 703    char *str;
 704
 705    /** Next entry in the linked list, or NULL if no more. */
 706    struct list_entry *next;
 707 };
 708
 709 /**
 710  * A header for a linked list of strings.
 711  */
 712 struct list
 713 {
 714    /** First entry in the list, or NULL if the list is empty. */
 715    struct list_entry *first;
 716
 717    /** Last entry in the list, or NULL if the list is empty. */
 718    struct list_entry *last;
 719 };
 720
 721
 722 /**
 723  * An entry in a map.  This is a name=value pair.
 724  */
 725 struct map_entry
 726 {
 727    /** The key for the map. */
 728    const char *name;
 729    /** The value associated with that key. */
 730    const char *value;
 731    /** The next map entry, or NULL if none. */
 732    struct map_entry *next;
 733 };
 734
 735 /**
 736  * A map from a string to another string.
 737  * This is used for the paramaters passed in a HTTP GET request, and
 738  * to store the exports when the CGI interface is filling in a template.
 739  */
 740 struct map
 741 {
 742    /** The first map entry, or NULL if the map is empty. */
 743    struct map_entry *first;
 744    /** The last map entry, or NULL if the map is empty. */
 745    struct map_entry *last;
 746 };
 747
 748
 749 /**
 750  * A HTTP request.  This includes the method (GET, POST) and
 751  * the parsed URL.
 752  *
 753  * This is also used whenever we want to match a URL against a
 754  * URL pattern.  This always contains the URL to match, and never
 755  * a URL pattern.  (See struct url_spec).
 756  */
 757 struct http_request
 758 {
 759    char *cmd;      /**< Whole command line: method, URL, Version */
 760    char *ocmd;     /**< Backup of original cmd for CLF logging */
 761    char *gpc;      /**< HTTP method: GET, POST, ... */
 762    char *url;      /**< The URL */
 763    char *ver;      /**< Protocol version */
 764    int status;     /**< HTTP Status */
 765
 766    char *host;     /**< Host part of URL */
 767    int   port;     /**< Port of URL or 80 (default) */
 768    char *path;     /**< Path of URL */
 769    char *hostport; /**< host[:port] */
 770    int   ssl;      /**< Flag if protocol is https */
 771
 772    char *host_ip_addr_str; /**< String with dotted decimal representation
 773                                 of host's IP. NULL before connect_to() */
 774
 775    char  *dbuffer; /**< Buffer with '\0'-delimited domain name.           */
 776    char **dvec;    /**< List of pointers to the strings in dbuffer.       */
 777    int    dcount;  /**< How many parts to this domain? (length of dvec)   */
 778 };
 779
 780
 781 /**
 782  * Response generated by CGI, blocker, or error handler
 783  */
 784 struct http_response
 785 {
 786   char  *status;          /**< HTTP status (string). */
 787   struct list headers[1]; /**< List of header lines. */
 788   char  *head;            /**< Formatted http response head. */
 789   size_t head_length;     /**< Length of http response head. */
 790   char  *body;            /**< HTTP document body. */
 791   size_t content_length;  /**< Length of body, REQUIRED if binary body. */
 792   int    is_static;       /**< Nonzero if the content will never change and
 793                                should be cached by the browser (e.g. images). */
 794 };
 795
 796 /**
 797  * A URL pattern.
 798  */
 799 struct url_spec
 800 {
 801    /** The string which was parsed to produce this url_spec.
 802        Used for debugging or display only.  */
 803    char  *spec;
 804
 805    char  *dbuffer;     /**< Buffer with '\0'-delimited domain name, or NULL to match all hosts. */
 806    char **dvec;        /**< List of pointers to the strings in dbuffer.       */
 807    int    dcount;      /**< How many parts to this domain? (length of dvec)   */
 808    int    unanchored;  /**< Bitmap - flags are ANCHOR_LEFT and ANCHOR_RIGHT.  */
 809
 810    int   port;         /**< The port number, or 0 to match all ports.         */
 811
 812    char *path;         /**< The source for the regex.                         */
 813    int   pathlen;      /**< ==strlen(path).  Needed for prefix matching.  FIXME: Now obsolete?     */
 814    regex_t *preg;      /**< Regex for matching path part                      */
 815 };
 816
 817 /**
 818  * If you declare a static url_spec, this is the value to initialize it to zero.
 819  */
 820 #define URL_SPEC_INITIALIZER { NULL, NULL, NULL, 0, 0, 0, NULL, 0, NULL }
 821
 822 /**
 823  * Constant for host part matching in URLs.  If set, indicates that the start of
 824  * the pattern must match the start of the URL.  E.g. this is not set for the
 825  * pattern ".example.com", so that it will match both "example.com" and
 826  * "www.example.com".  It is set for the pattern "example.com", which makes it
 827  * match "example.com" only, not "www.example.com".
 828  */
 829 #define ANCHOR_LEFT  1
 830
 831 /**
 832  * Constant for host part matching in URLs.  If set, indicates that the end of
 833  * the pattern must match the end of the URL.  E.g. this is not set for the
 834  * pattern "ad.", so that it will match any host called "ad", irrespective
 835  * of how many subdomains are in the fully-qualified domain name.
 836  */
 837 #define ANCHOR_RIGHT 2
 838
 839
 840 /**
 841  * An I/O buffer.  Holds a string which can be appended to, and can have data
 842  * removed from the beginning.
 843  */
 844 struct iob
 845 {
 846    char *buf;    /**< Start of buffer        */
 847    char *cur;    /**< Start of relevant data */
 848    char *eod;    /**< End of relevant data   */
 849    size_t size;  /**< Size as malloc()ed     */
 850 };
 851
 852
 853 /**
 854  * Return the number of bytes in the I/O buffer associated with the passed
 855  * client_state pointer.
 856  * May be zero.
 857  */
 858 #define IOB_PEEK(CSP) ((CSP->iob->cur > CSP->iob->eod) ? (CSP->iob->eod - CSP->iob->cur) : 0)
 859
 860
 861 /**
 862  * Remove any data in the I/O buffer associated with the passed
 863  * client_state pointer.
 864  */
 865 #define IOB_RESET(CSP) if(CSP->iob->buf) free(CSP->iob->buf); memset(CSP->iob, '\0', sizeof(CSP->iob));
 866
 867 /* Bits for csp->content_type */
 868 #define CT_TEXT   1 /**< csp->content_type bitmask:
 869                          Suitable for pcrs filtering. */
 870 #define CT_GIF    2 /**< csp->content_type bitmask:
 871                          Suitable for GIF filtering.  */
 872 #define CT_TABOO  4 /**< csp->content_type bitmask:
 873                          DO NOT filter, irrespective of other flags. */
 874 #define CT_JPEG   8 /**< csp->content_type bitmask:
 875                          Suitable for JPEG filtering.  */
 876
 877 /**
 878  * The mask which includes all actions.
 879  */
 880 #define ACTION_MASK_ALL        (~0UL)
 881
 882 /**
 883  * The most compatible set of actions - i.e. none.
 884  */
 885 #define ACTION_MOST_COMPATIBLE                       0x00000000UL
 886
 887 /** Action bitmap: Block the request. */
 888 #define ACTION_BLOCK                                 0x00000001UL
 889 /** Action bitmap: Deanimate if it's a GIF. */
 890 #define ACTION_DEANIMATE                             0x00000002UL
 891 /** Action bitmap: Downgrade HTTP/1.1 to 1.0. */
 892 #define ACTION_DOWNGRADE                             0x00000004UL
 893 /** Action bitmap: Fast redirects. */
 894 #define ACTION_FAST_REDIRECTS                        0x00000008UL
 895 /** Action bitmap: Remove existing "Forwarded" header, and do not add another. */
 896 #define ACTION_HIDE_FORWARDED                        0x00000010UL
 897 /** Action bitmap: Hide "From" header. */
 898 #define ACTION_HIDE_FROM                             0x00000020UL
 899 /** Action bitmap: Hide "Referer" header.  (sic - follow HTTP, not English). */
 900 #define ACTION_HIDE_REFERER                          0x00000040UL
 901 /** Action bitmap: Hide "User-Agent" and similar headers. */
 902 #define ACTION_HIDE_USER_AGENT                       0x00000080UL
 903 /** Action bitmap: This is an image. */
 904 #define ACTION_IMAGE                                 0x00000100UL
 905 /** Action bitmap: Sets the image blocker. */
 906 #define ACTION_IMAGE_BLOCKER                         0x00000200UL
 907 /** Action bitmap: Prevent compression. */
 908 #define ACTION_NO_COMPRESSION                        0x00000400UL
 909 /** Action bitmap: Change cookies to session only cookies. */
 910 #define ACTION_NO_COOKIE_KEEP                        0x00000800UL
 911 /** Action bitmap: Block rending cookies. */
 912 #define ACTION_NO_COOKIE_READ                        0x00001000UL
 913 /** Action bitmap: Block setting cookies. */
 914 #define ACTION_NO_COOKIE_SET                         0x00002000UL
 915 /** Action bitmap: Filter out popups. */
 916 #define ACTION_NO_POPUPS                             0x00004000UL
 917 /** Action bitmap: Send a vanilla wafer. */
 918 #define ACTION_VANILLA_WAFER                         0x00008000UL
 919 /** Action bitmap: Limit CONNECT requests to safe ports. */
 920 #define ACTION_LIMIT_CONNECT                         0x00010000UL
 921 /** Action bitmap: Inspect if it's a JPEG. */
 922 #define ACTION_JPEG_INSPECT                          0x00020000UL
 923 /** Action bitmap: Crunch or modify "if-modified-since" header. */
 924 #define ACTION_HIDE_IF_MODIFIED_SINCE                0x00040000UL
 925 /** Action bitmap: Overwrite Content-Type header. */
 926 #define ACTION_CONTENT_TYPE_OVERWRITE                0x00080000UL
 927 /** Action bitmap: Crunch specified server header. */
 928 #define ACTION_CRUNCH_SERVER_HEADER                  0x00100000UL
 929 /** Action bitmap: Crunch specified client header */
 930 #define ACTION_CRUNCH_CLIENT_HEADER                  0x00200000UL
 931 /** Action bitmap: Enable text mode by force */
 932 #define ACTION_FORCE_TEXT_MODE                       0x00400000UL
 933 /** Action bitmap: Enable text mode by force */
 934 #define ACTION_CRUNCH_IF_NONE_MATCH                  0x00800000UL
 935 /** Action bitmap: Enable content-dispostion crunching */
 936 #define ACTION_HIDE_CONTENT_DISPOSITION              0x01000000UL
 937 /** Action bitmap: Replace or block Last-Modified header */
 938 #define ACTION_OVERWRITE_LAST_MODIFIED               0x02000000UL
 939 /** Action bitmap: Replace or block Accept-Language header */
 940 #define ACTION_HIDE_ACCEPT_LANGUAGE                  0x04000000UL
 941 /** Action bitmap: Block as empty document */
 942 #define  ACTION_HANDLE_AS_EMPTY_DOCUMENT             0x08000000UL
 943 /** Action bitmap: Redirect request. */
 944 #define  ACTION_REDIRECT                             0x10000000UL
 945 /** Action bitmap: Answer blocked Connects verbosely */
 946 #define ACTION_TREAT_FORBIDDEN_CONNECTS_LIKE_BLOCKS  0x20000000UL
 947 /** Action bitmap: Filter server headers with pcre */
 948 #define ACTION_FILTER_SERVER_HEADERS                 0x40000000UL
 949 /** Action bitmap: Filter client headers with pcre */
 950 #define ACTION_FILTER_CLIENT_HEADERS                 0x80000000UL
 951
 952
 953 /** Action string index: How to deanimate GIFs */
 954 #define ACTION_STRING_DEANIMATE             0
 955 /** Action string index: Replacement for "From:" header */
 956 #define ACTION_STRING_FROM                  1
 957 /** Action string index: How to block images */
 958 #define ACTION_STRING_IMAGE_BLOCKER         2
 959 /** Action string index: Replacement for "Referer:" header */
 960 #define ACTION_STRING_REFERER               3
 961 /** Action string index: Replacement for "User-Agent:" header */
 962 #define ACTION_STRING_USER_AGENT            4
 963 /** Action string index: Legal CONNECT ports. */
 964 #define ACTION_STRING_LIMIT_CONNECT         5
 965 /** Action string index: Server headers containing this pattern are crunched*/
 966 #define ACTION_STRING_SERVER_HEADER         6
 967 /** Action string index: Client headers containing this pattern are crunched*/
 968 #define ACTION_STRING_CLIENT_HEADER         7
 969 /** Action string index: Replacement for the "Accept-Language:" header*/
 970 #define ACTION_STRING_LANGUAGE              8
 971 /** Action string index: Replacement for the "Content-Type:" header*/
 972 #define ACTION_STRING_CONTENT_TYPE          9
 973 /** Action string index: Replacement for the "content-dispostion:" header*/
 974 #define ACTION_STRING_CONTENT_DISPOSITION  10
 975 /** Action string index: Replacement for the "If-Modified-Since:" header*/
 976 #define ACTION_STRING_IF_MODIFIED_SINCE    11
 977 /** Action string index: Replacement for the "Last-Modified:" header. */
 978 #define ACTION_STRING_LAST_MODIFIED        12
 979 /** Action string index: Redirect URL */
 980 #define ACTION_STRING_REDIRECT             13
 981 /** Action string index: Decode before redirect? */
 982 #define ACTION_STRING_FAST_REDIRECTS       14
 983 /** Number of string actions. */
 984 #define ACTION_STRING_COUNT                15
 985
 986
 987 /*To make the ugly hack in sed easier to understand*/
 988 #define CHECK_EVERY_HEADER_REMAINING 0
 989
 990
 991 /** Index into current_action_spec::multi[] for headers to add. */
 992 #define ACTION_MULTI_ADD_HEADER     0
 993 /** Index into current_action_spec::multi[] for headers to add. */
 994 #define ACTION_MULTI_WAFER          1
 995 /** Index into current_action_spec::multi[] for filters to apply. */
 996 #define ACTION_MULTI_FILTER         2
 997 /** Number of multi-string actions. */
 998 #define ACTION_MULTI_COUNT          3
 999
1000
1001 /**
1002  * This structure contains a list of actions to apply to a URL.
1003  * It only contains positive instructions - no "-" options.
1004  * It is not used to store the actions list itself, only for
1005  * url_actions() to return the current values.
1006  */
1007 struct current_action_spec
1008 {
1009    /** Actions to apply.  A bit set to "1" means perform the action. */
1010    unsigned long flags;
1011
1012    /**
1013     * Paramaters for those actions that require them.
1014     * Each entry is valid if & only if the corresponding entry in "flags" is
1015     * set.
1016     */
1017    char * string[ACTION_STRING_COUNT];
1018
1019    /** Lists of strings for multi-string actions. */
1020    struct list multi[ACTION_MULTI_COUNT][1];
1021 };
1022
1023
1024 /**
1025  * This structure contains a set of changes to actions.
1026  * It can contain both positive and negative instructions.
1027  * It is used to store an entry in the actions list.
1028  */
1029 struct action_spec
1030 {
1031    unsigned long mask; /**< Actions to keep. A bit set to "0" means remove action. */
1032    unsigned long add;  /**< Actions to add.  A bit set to "1" means add action.    */
1033
1034    /**
1035     * Paramaters for those actions that require them.
1036     * Each entry is valid if & only if the corresponding entry in "flags" is
1037     * set.
1038     */
1039    char * string[ACTION_STRING_COUNT];
1040
1041    /** Lists of strings to remove, for multi-string actions. */
1042    struct list multi_remove[ACTION_MULTI_COUNT][1];
1043
1044    /** If nonzero, remove *all* strings from the multi-string action. */
1045    int         multi_remove_all[ACTION_MULTI_COUNT];
1046
1047    /** Lists of strings to add, for multi-string actions. */
1048    struct list multi_add[ACTION_MULTI_COUNT][1];
1049 };
1050
1051
1052 /**
1053  * This structure is used to store the actions list.
1054  *
1055  * It contains a URL pattern, and the chages to the actions.
1056  * It is a linked list.
1057  */
1058 struct url_actions
1059 {
1060    struct url_spec url[1];        /**< URL pattern. */
1061
1062    struct action_spec action[1];  /**< Actions. */
1063
1064    struct url_actions * next;     /**< Next action in file, or NULL. */
1065 };
1066
1067
1068 /*
1069  * Flags for use in csp->flags
1070  */
1071
1072 /**
1073  * Flag for csp->flags: Set if this client is processing data.
1074  * Cleared when the thread associated with this structure dies.
1075  */
1076 #define CSP_FLAG_ACTIVE     0x01
1077
1078 /**
1079  * Flag for csp->flags: Set if the server's reply is in "chunked"
1080  * transfer encoding
1081  */
1082 #define CSP_FLAG_CHUNKED    0x02
1083
1084 /**
1085  * Flag for csp->flags: Set if this request was enforced, although it would
1086  * normally have been blocked.
1087  */
1088 #define CSP_FLAG_FORCED     0x04
1089
1090 /**
1091  * Flag for csp->flags: Set if any modification to the body was done.
1092  */
1093 #define CSP_FLAG_MODIFIED   0x08
1094
1095 /**
1096  * Flag for csp->flags: Set if request was blocked.
1097  */
1098 #define CSP_FLAG_REJECTED   0x10
1099
1100 /**
1101  * Flag for csp->flags: Set if we are toggled on (FEATURE_TOGGLE).
1102  */
1103 #define CSP_FLAG_TOGGLED_ON 0x20
1104
1105
1106 /*
1107  * Flags for use in return codes of child processes
1108  */
1109
1110 /**
1111  * Flag for process return code: Set if exiting porcess has been toggled
1112  * during its lifetime.
1113  */
1114 #define RC_FLAG_TOGGLED   0x10
1115
1116 /**
1117  * Flag for process return code: Set if exiting porcess has blocked its
1118  * request.
1119  */
1120 #define RC_FLAG_BLOCKED   0x20
1121
1122 /**
1123  * Maximum number of actions/filter files.  This limit is arbitrary - it's just used
1124  * to size an array.
1125  */
1126 #define MAX_AF_FILES 10
1127
1128 /**
1129  * The state of a Privoxy processing thread.
1130  */
1131 struct client_state
1132 {
1133    /** The proxy's configuration */
1134    struct configuration_spec * config;
1135
1136    /** The actions to perform on the current request */
1137    struct current_action_spec  action[1];
1138
1139    /** socket to talk to client (web browser) */
1140    jb_socket cfd;
1141
1142    /** socket to talk to server (web server or proxy) */
1143    jb_socket sfd;
1144
1145    /** Multi-purpose flag container, see CSP_FLAG_* above */
1146    unsigned short int flags;
1147
1148    /** Client PC's IP address, as reported by the accept() function.
1149        As a string. */
1150    char *ip_addr_str;
1151    /** Client PC's IP address, as reported by the accept() function.
1152        As a number. */
1153    long  ip_addr_long;
1154
1155    /** Our IP address. I.e. the IP address that the client used to reach us,
1156        as a string. */
1157    char *my_ip_addr_str;
1158
1159    /** Our hostname. I.e. the reverse DNS of the IP address that the client
1160        used to reach us, as a string. */
1161    char *my_hostname;
1162
1163    /** The URL that was requested */
1164    struct http_request http[1];
1165
1166    /** An I/O buffer used for buffering data read from the network */
1167    struct iob iob[1];
1168
1169    /** List of all headers for this request */
1170    struct list headers[1];
1171
1172    /** List of all cookies for this request */
1173    struct list cookie_list[1];
1174
1175    /** MIME-Type key, see CT_* above */
1176    unsigned short int content_type;
1177
1178    /** The "X-Forwarded-For:" header sent by the client */
1179    char   *x_forwarded;
1180
1181    /** Actions files associated with this client */
1182    struct file_list *actions_list[MAX_AF_FILES];
1183
1184    /** pcrs job files. */
1185    struct file_list *rlist[MAX_AF_FILES];
1186
1187    /** Length after content modification. */
1188    size_t content_length;
1189
1190 #ifdef FEATURE_TRUST
1191
1192    /** Trust file. */
1193    struct file_list *tlist;
1194
1195 #endif /* def FEATURE_TRUST */
1196
1197    /** Next thread in linked list. Only read or modify from the main thread! */
1198    struct client_state *next;
1199 };
1200
1201
1202 /**
1203  * A function to add a header
1204  */
1205 typedef jb_err (*add_header_func_ptr)(struct client_state *);
1206
1207 /**
1208  * A function to process a header
1209  */
1210 typedef jb_err (*parser_func_ptr    )(struct client_state *, char **);
1211
1212
1213 /**
1214  * List of functions to run on a list of headers
1215  */
1216 struct parsers
1217 {
1218    /** The header prefix to match */
1219    char   *str;
1220
1221    /** The length of the prefix to match */
1222    size_t len;
1223
1224    /** The function to apply to this line */
1225    parser_func_ptr parser;
1226 };
1227
1228
1229 /**
1230  * List of available CGI functions.
1231  */
1232 struct cgi_dispatcher
1233 {
1234    /** The URL of the CGI, relative to the CGI root. */
1235    const char * const name;
1236
1237    /** The handler function for the CGI */
1238    jb_err    (* const handler)(struct client_state *csp, struct http_response *rsp, const struct map *parameters);
1239
1240    /** The description of the CGI, to appear on the main menu, or NULL to hide it. */
1241    const char * const description;
1242
1243    /** A flag that indicates whether unintentional calls to this CGI can cause damage */
1244    int harmless;
1245 };
1246
1247
1248 /**
1249  * A data file used by Privoxy.  Kept in a linked list.
1250  */
1251 struct file_list
1252 {
1253    /**
1254     * This is a pointer to the data structures associated with the file.
1255     * Read-only once the structure has been created.
1256     */
1257    void *f;
1258
1259    /**
1260     * The unloader function.
1261     * Normally NULL.  When we are finished with file (i.e. when we have
1262     * loaded a new one), set to a pointer to an unloader function.
1263     * Unloader will be called by sweep() (called from main loop) when
1264     * all clients using this file are done.  This prevents threading
1265     * problems.
1266     */
1267    void (*unloader)(void *);
1268
1269    /**
1270     * Used internally by sweep().  Do not access from elsewhere.
1271     */
1272    int active;
1273
1274    /**
1275     * File last-modified time, so we can check if file has been changed.
1276     * Read-only once the structure has been created.
1277     */
1278    time_t lastmodified;
1279
1280    /**
1281     * The full filename.
1282     */
1283    char * filename;
1284
1285    /**
1286     * Pointer to next entry in the linked list of all "file_list"s.
1287     * This linked list is so that sweep() can navigate it.
1288     * Since sweep() can remove items from the list, we must be careful
1289     * to only access this value from main thread (when we know sweep
1290     * won't be running).
1291     */
1292    struct file_list *next;
1293 };
1294
1295
1296 #ifdef FEATURE_TRUST
1297
1298 /**
1299  * The format of a trust file when loaded into memory.
1300  */
1301 struct block_spec
1302 {
1303    struct url_spec url[1];   /**< The URL pattern              */
1304    int    reject;            /**< FIXME: Please document this! */
1305    struct block_spec *next;  /**< Next entry in linked list    */
1306 };
1307
1308 /**
1309  * Arbitrary limit for the number of trusted referrers
1310  * Privoxy can print in its blocking message.
1311  */
1312 #define MAX_TRUSTED_REFERRERS 512
1313
1314 #endif /* def FEATURE_TRUST */
1315
1316
1317 #define SOCKS_NONE    0    /**< Don't use a SOCKS server               */
1318 #define SOCKS_4      40    /**< original SOCKS 4 protocol              */
1319 #define SOCKS_4A     41    /**< as modified for hosts w/o external DNS */
1320
1321
1322 /**
1323  * How to forward a connection to a parent proxy.
1324  */
1325 struct forward_spec
1326 {
1327    /** URL pattern that this forward_spec is for. */
1328    struct url_spec url[1];
1329
1330    /** Connection type.  Must be SOCKS_NONE, SOCKS_4, or SOCKS_4A. */
1331    int   type;
1332
1333    /** SOCKS server hostname.  Only valid if "type" is SOCKS_4 or SOCKS_4A. */
1334    char *gateway_host;
1335
1336    /** SOCKS server port. */
1337    int   gateway_port;
1338
1339    /** Parent HTTP proxy hostname, or NULL for none. */
1340    char *forward_host;
1341
1342    /** Parent HTTP proxy port. */
1343    int   forward_port;
1344
1345    /** Next entry in the linked list. */
1346    struct forward_spec *next;
1347 };
1348
1349
1350 /**
1351  * Initializer for a static struct forward_spec.
1352  */
1353 #define FORWARD_SPEC_INITIALIZER { { URL_SPEC_INITIALIZER }, 0, NULL, 0, NULL, 0, NULL }
1354
1355
1356 /**
1357  * This struct represents one filter (one block) from
1358  * the re_filterfile. If there is more than one filter
1359  * in the file, the file will be represented by a
1360  * chained list of re_filterfile specs.
1361  */
1362 struct re_filterfile_spec
1363 {
1364    char *name;                      /**< Name from FILTER: statement in re_filterfile. */
1365    char *description;               /**< Description from FILTER: statement in re_filterfile. */
1366    struct list patterns[1];         /**< The patterns from the re_filterfile. */
1367    pcrs_job *joblist;               /**< The resulting compiled pcrs_jobs. */
1368    struct re_filterfile_spec *next; /**< The pointer for chaining. */
1369 };
1370
1371
1372 #ifdef FEATURE_ACL
1373
1374 #define ACL_PERMIT   1  /**< Accept connection request */
1375 #define ACL_DENY     2  /**< Reject connection request */
1376
1377 /**
1378  * An IP address pattern.  Used to specify networks in the ACL.
1379  */
1380 struct access_control_addr
1381 {
1382    unsigned long addr;  /**< The IP address as an integer. */
1383    unsigned long mask;  /**< The network mask as an integer. */
1384    unsigned long port;  /**< The port number. */
1385 };
1386
1387 /**
1388  * An access control list (ACL) entry.
1389  *
1390  * This is a linked list.
1391  */
1392 struct access_control_list
1393 {
1394    struct access_control_addr src[1];  /**< Client IP address */
1395    struct access_control_addr dst[1];  /**< Website or parent proxy IP address */
1396
1397    short action;                       /**< ACL_PERMIT or ACL_DENY */
1398    struct access_control_list *next;   /**< The next entry in the ACL. */
1399 };
1400
1401 #endif /* def FEATURE_ACL */
1402
1403
1404 /** Maximum number of loaders (actions, re_filter, ...) */
1405 #define NLOADERS 8
1406
1407
1408 /** configuration_spec::feature_flags: CGI actions editor. */
1409 #define RUNTIME_FEATURE_CGI_EDIT_ACTIONS  1
1410
1411 /** configuration_spec::feature_flags: Web-based toggle. */
1412 #define RUNTIME_FEATURE_CGI_TOGGLE        2
1413
1414 /** configuration_spec::feature_flags: HTTP-header-based toggle. */
1415 #define RUNTIME_FEATURE_HTTP_TOGGLE       4
1416
1417 /**
1418  * Data loaded from the configuration file.
1419  *
1420  * (Anomaly: toggle is still handled through a global, not this structure)
1421  */
1422 struct configuration_spec
1423 {
1424    /** What to log */
1425    int debug;
1426
1427    /** Nonzero to enable multithreading. */
1428    int multi_threaded;
1429
1430    /**
1431     * Bitmask of features that can be enabled/disabled through the config
1432     * file.  Currently defined bits:
1433     *
1434     * - RUNTIME_FEATURE_CGI_EDIT_ACTIONS
1435     * - RUNTIME_FEATURE_CGI_TOGGLE
1436     * - RUNTIME_FEATURE_HTTP_TOGGLE
1437     */
1438    unsigned feature_flags;
1439
1440    /** The log file name. */
1441    const char *logfile;
1442
1443    /** The config file directory. */
1444    const char *confdir;
1445
1446    /** The log file directory. */
1447    const char *logdir;
1448
1449    /** The full paths to the actions files. */
1450    const char *actions_file[MAX_AF_FILES];
1451
1452    /** The short names of the actions files. */
1453    const char *actions_file_short[MAX_AF_FILES];
1454
1455    /** The administrator's email address */
1456    char *admin_address;
1457
1458    /** A URL with info on this proxy */
1459    char *proxy_info_url;
1460
1461    /** URL to the user manual (on our website or local copy) */
1462    char *usermanual;
1463
1464    /** The file names of the pcre filter files. */
1465    const char *re_filterfile[MAX_AF_FILES];
1466
1467    /** The short names of the pcre filter files. */
1468    const char *re_filterfile_short[MAX_AF_FILES];
1469
1470 #ifdef FEATURE_COOKIE_JAR
1471
1472    /** The file name of the cookie jar file */
1473    const char * jarfile;
1474
1475    /** The handle to the cookie jar file */
1476    FILE * jar;
1477
1478 #endif /* def FEATURE_COOKIE_JAR */
1479
1480    /** IP address to bind to.  Defaults to HADDR_DEFAULT == 127.0.0.1. */
1481    const char *haddr;
1482
1483    /** Port to bind to.  Defaults to HADDR_PORT == 8118. */
1484    int         hport;
1485
1486    /** Size limit for IOB */
1487    size_t buffer_limit;
1488
1489 #ifdef FEATURE_TRUST
1490
1491    /** The file name of the trust file. */
1492    const char * trustfile;
1493
1494    /** FIXME: DOCME: Document this. */
1495    struct list trust_info[1];
1496
1497    /** FIXME: DOCME: Document this. */
1498    struct url_spec *trust_list[MAX_TRUSTED_REFERRERS];
1499
1500 #endif /* def FEATURE_TRUST */
1501
1502 #ifdef FEATURE_ACL
1503
1504    /** The access control list (ACL). */
1505    struct access_control_list *acl;
1506
1507 #endif /* def FEATURE_ACL */
1508
1509    /** Information about parent proxies (forwarding). */
1510    struct forward_spec *forward;
1511
1512    /** Number of retries in case a forwarded connection attempt fails */
1513    int         forwarded_connect_retries;
1514
1515    /** All options from the config file, HTML-formatted. */
1516    char *proxy_args;
1517
1518    /** The configuration file object. */
1519    struct file_list *config_file_list;
1520
1521    /** List of loaders */
1522    int (*loaders[NLOADERS])(struct client_state *);
1523
1524    /** Nonzero if we need to bind() to the new port. */
1525    int need_bind;
1526 };
1527
1528 /** Calculates the number of elements in an array, using sizeof. */
1529 #define SZ(X)  (sizeof(X) / sizeof(*X))
1530
1531 #ifdef FEATURE_FORCE_LOAD
1532 /** The force load URL prefix. */
1533 #define FORCE_PREFIX "/PRIVOXY-FORCE"
1534 #endif /* def FEATURE_FORCE_LOAD */
1535
1536 #ifdef FEATURE_NO_GIFS
1537 /** The MIME type for images ("image/png" or "image/gif"). */
1538 #define BUILTIN_IMAGE_MIMETYPE "image/png"
1539 #else
1540 #define BUILTIN_IMAGE_MIMETYPE "image/gif"
1541 #endif /* def FEATURE_NO_GIFS */
1542
1543
1544 /*
1545  * Hardwired URLs
1546  */
1547
1548 /** URL for the Privoxy home page. */
1549 #define HOME_PAGE_URL     "http://www.privoxy.org/"
1550
1551 /** URL for the Privoxy user manual. */
1552 #define USER_MANUAL_URL   HOME_PAGE_URL VERSION "/user-manual/"
1553
1554 /** Prefix for actions help links  (append to USER_MANUAL_URL). */
1555 #define ACTIONS_HELP_PREFIX "actions-file.html#"
1556
1557 /** Prefix for config option help links (append to USER_MANUAL_URL). */
1558 #define CONFIG_HELP_PREFIX  "config.html#"
1559
1560 /*
1561  * The "hosts" to intercept and display CGI pages.
1562  * First one is a hostname only, second one can specify host and path.
1563  *
1564  * Notes:
1565  * 1) Do not specify the http: prefix
1566  * 2) CGI_SITE_2_PATH must not end with /, one will be added automatically.
1567  * 3) CGI_SITE_2_PATH must start with /, unless it is the empty string.
1568  */
1569 #define CGI_SITE_1_HOST "p.p"
1570 #define CGI_SITE_2_HOST "config.privoxy.org"
1571 #define CGI_SITE_2_PATH ""
1572
1573 /**
1574  * The prefix for CGI pages.  Written out in generated HTML.
1575  * INCLUDES the trailing slash.
1576  */
1577 #define CGI_PREFIX  "http://" CGI_SITE_2_HOST CGI_SITE_2_PATH "/"
1578
1579
1580 /* HTTP snipplets.
1581  *
1582  * FIXME: This is very inefficient.  There could be one copy of these strings
1583  * for each .c file!!  They should be "extern", not "static".
1584  */
1585 static const char CSUCCEED[] =
1586    "HTTP/1.0 200 Connection established\n"
1587    "Proxy-Agent: Privoxy/" VERSION "\r\n\r\n";
1588
1589 static const char CHEADER[] =
1590    "HTTP/1.0 400 Invalid header received from browser\r\n\r\n";
1591
1592 static const char CFORBIDDEN[] =
1593    "HTTP/1.0 403 Connection not allowable\r\nX-Hint: If you read this message interactively, then you know why this happens ,-)\r\n\r\n";
1594
1595 static const char FTP_RESPONSE[] =
1596    "HTTP/1.0 400 Invalid header received from browser\r\n\r\nPrivoxy doesn't support FTP. Please fix your setup.";
1597
1598
1599 #ifdef __cplusplus
1600 } /* extern "C" */
1601 #endif
1602
1603 #endif /* ndef PROJECT_H_INCLUDED */
1604
1605 /*
1606   Local Variables:
1607   tab-width: 3
1608   end:
1609 */