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