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