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