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