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