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