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