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