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