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