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