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