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