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