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