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