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