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