project.h

   1 #ifndef PROJECT_H_INCLUDED
   2 #define PROJECT_H_INCLUDED
   3 #define PROJECT_H_VERSION "$Id: project.h,v 1.57 2002/03/16 20:28:34 oes Exp $"
   4 /*********************************************************************
   5  *
   6  * File        :  $Source: /cvsroot/ijbswa/current/project.h,v $
   7  *
   8  * Purpose     :  Defines data structures which are widely used in the
   9  *                project.  Does not define any variables or functions
  10  *                (though it does declare some macros).
  11  *
  12  * Copyright   :  Written by and Copyright (C) 2001 the SourceForge
  13  *                Privoxy team.  http://ijbswa.sourceforge.net
  14  *
  15  *                Based on the Internet Junkbuster originally written
  16  *                by and Copyright (C) 1997 Anonymous Coders and
  17  *                Junkbusters Corporation.  http://www.junkbusters.com
  18  *
  19  *                This program is free software; you can redistribute it
  20  *                and/or modify it under the terms of the GNU General
  21  *                Public License as published by the Free Software
  22  *                Foundation; either version 2 of the License, or (at
  23  *                your option) any later version.
  24  *
  25  *                This program is distributed in the hope that it will
  26  *                be useful, but WITHOUT ANY WARRANTY; without even the
  27  *                implied warranty of MERCHANTABILITY or FITNESS FOR A
  28  *                PARTICULAR PURPOSE.  See the GNU General Public
  29  *                License for more details.
  30  *
  31  *                The GNU General Public License should be included with
  32  *                this file.  If not, you can view it at
  33  *                http://www.gnu.org/copyleft/gpl.html
  34  *                or write to the Free Software Foundation, Inc., 59
  35  *                Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  36  *
  37  * Revisions   :
  38  *    $Log: project.h,v $
  39  *    Revision 1.57  2002/03/16 20:28:34  oes
  40  *    Added descriptions to the filters so users will know what they select in the cgi editor
  41  *
  42  *    Revision 1.56  2002/03/13 20:27:30  oes
  43  *    Fixing bug with CT_TABOO
  44  *
  45  *    Revision 1.55  2002/03/12 01:42:50  oes
  46  *    Introduced modular filters
  47  *
  48  *    Revision 1.54  2002/03/09 20:03:52  jongfoster
  49  *    - Making various functions return int rather than size_t.
  50  *      (Undoing a recent change).  Since size_t is unsigned on
  51  *      Windows, functions like read_socket that return -1 on
  52  *      error cannot return a size_t.
  53  *
  54  *      THIS WAS A MAJOR BUG - it caused frequent, unpredictable
  55  *      crashes, and also frequently caused JB to jump to 100%
  56  *      CPU and stay there.  (Because it thought it had just
  57  *      read ((unsigned)-1) == 4Gb of data...)
  58  *
  59  *    - The signature of write_socket has changed, it now simply
  60  *      returns success=0/failure=nonzero.
  61  *
  62  *    - Trying to get rid of a few warnings --with-debug on
  63  *      Windows, I've introduced a new type "jb_socket".  This is
  64  *      used for the socket file descriptors.  On Windows, this
  65  *      is SOCKET (a typedef for unsigned).  Everywhere else, it's
  66  *      an int.  The error value can't be -1 any more, so it's
  67  *      now JB_INVALID_SOCKET (which is -1 on UNIX, and in
  68  *      Windows it maps to the #define INVALID_SOCKET.)
  69  *
  70  *    - The signature of bind_port has changed.
  71  *
  72  *    Revision 1.53  2002/03/08 16:48:55  oes
  73  *    Added FEATURE_NO_GIFS and BUILTIN_IMAGE_MIMETYPE
  74  *
  75  *    Revision 1.52  2002/03/07 03:46:17  oes
  76  *    Fixed compiler warnings
  77  *
  78  *    Revision 1.51  2002/03/05 04:52:42  oes
  79  *    Deleted non-errlog debugging code
  80  *
  81  *    Revision 1.50  2002/03/04 19:32:07  oes
  82  *    Changed default port to 8118
  83  *
  84  *    Revision 1.49  2002/03/04 18:28:55  oes
  85  *    Deleted PID_FILE_NAME
  86  *
  87  *    Revision 1.48  2002/03/03 14:50:40  oes
  88  *    Fixed CLF logging: Added ocmd member for client's request to struct http_request
  89  *
  90  *    Revision 1.47  2002/02/20 23:15:13  jongfoster
  91  *    Parsing functions now handle out-of-memory gracefully by returning
  92  *    an error code.
  93  *
  94  *    Revision 1.46  2002/01/17 21:06:09  jongfoster
  95  *    Now #defining the URLs of the config interface
  96  *
  97  *    Minor changes to struct http_request and struct url_spec due to
  98  *    standardizing that struct http_request is used to represent a URL, and
  99  *    struct url_spec is used to represent a URL pattern.  (Before, URLs were
 100  *    represented as seperate variables and a partially-filled-in url_spec).
 101  *
 102  *    Revision 1.45  2002/01/09 14:33:27  oes
 103  *    Added HOSTENT_BUFFER_SIZE
 104  *
 105  *    Revision 1.44  2001/12/30 14:07:32  steudten
 106  *    - Add signal handling (unix)
 107  *    - Add SIGHUP handler (unix)
 108  *    - Add creation of pidfile (unix)
 109  *    - Add action 'top' in rc file (RH)
 110  *    - Add entry 'SIGNALS' to manpage
 111  *    - Add exit message to logfile (unix)
 112  *
 113  *    Revision 1.43  2001/11/22 21:57:51  jongfoster
 114  *    Making action_spec->flags into an unsigned long rather than just an
 115  *    unsigned int.
 116  *    Adding ACTION_NO_COOKIE_KEEP
 117  *
 118  *    Revision 1.42  2001/11/05 21:42:41  steudten
 119  *    Include DBG() macro.
 120  *
 121  *    Revision 1.41  2001/10/28 19:12:06  jongfoster
 122  *    Adding ijb_toupper()
 123  *
 124  *    Revision 1.40  2001/10/26 17:40:47  oes
 125  *    Moved ijb_isspace and ijb_tolower to project.h
 126  *    Removed http->user_agent, csp->referrer and csp->accept_types
 127  *
 128  *    Revision 1.39  2001/10/25 03:45:02  david__schmidt
 129  *    Adding a (void*) cast to freez() because Visual Age C++ won't expand the
 130  *    macro when called with a cast; so moving the cast to the macro def'n
 131  *    seems to both eliminate compiler warnings (on darwin and OS/2, anyway) and
 132  *    doesn't make macro expansion complain.  Hope this works for everyone else
 133  *    too...
 134  *
 135  *    Revision 1.38  2001/10/23 21:19:04  jongfoster
 136  *    New error-handling support: jb_err type and JB_ERR_xxx constants
 137  *    CGI functions now return a jb_err, and their parameters map is const.
 138  *    Support for RUNTIME_FEATUREs to enable/disable config editor
 139  *    Adding a few comments
 140  *
 141  *    Revision 1.37  2001/10/14 22:14:01  jongfoster
 142  *    Removing name_length field from struct cgi_dispatcher, as this is
 143  *    now calculated at runtime from the "name" field.
 144  *
 145  *    Revision 1.36  2001/10/10 16:45:15  oes
 146  *    Added LIMIT_CONNECT action and string
 147  *    Fixed HTTP message line termination
 148  *    Added CFORBIDDEN HTTP message
 149  *
 150  *    Revision 1.35  2001/10/07 18:06:43  oes
 151  *    Added status member to struct http_request
 152  *
 153  *    Revision 1.34  2001/10/07 15:45:25  oes
 154  *    Added url member to struct http_request and commented all
 155  *      members
 156  *
 157  *    Added CT_TABOO
 158  *
 159  *    Added ACTION_DOWNGRADE and ACTION_NO_COMPRESSION
 160  *
 161  *    Replaced struct client_state members rejected,
 162  *      force, active and toggled_on with "flags" bitmap.
 163  *
 164  *    Added CSP_FLAG_MODIFIED and CSP_FLAG_CHUNKED
 165  *
 166  *    Added buffer_limit to struct configuration_spec
 167  *
 168  *    Revision 1.33  2001/09/20 13:30:08  steudten
 169  *
 170  *    Make freez() more secure in case of: if (exp) { free(z) ; a=*z }
 171  *    Last case will set z to NULL in free(z) and thats bad..
 172  *
 173  *    Revision 1.32  2001/09/16 23:02:51  jongfoster
 174  *    Fixing warning
 175  *
 176  *    Revision 1.31  2001/09/16 13:20:29  jongfoster
 177  *    Rewrite of list library.  Now has seperate header and list_entry
 178  *    structures.  Also added a large sprinking of assert()s to the list
 179  *    code.
 180  *
 181  *    Revision 1.30  2001/09/13 23:52:00  jongfoster
 182  *    Support for both static and dynamically generated CGI pages
 183  *
 184  *    Revision 1.29  2001/09/13 23:29:43  jongfoster
 185  *    Defining FORWARD_SPEC_INITIALIZER
 186  *
 187  *    Revision 1.28  2001/09/13 23:05:50  jongfoster
 188  *    Changing the string paramater to the header parsers a "const".
 189  *
 190  *    Revision 1.27  2001/08/05 16:06:20  jongfoster
 191  *    Modifiying "struct map" so that there are now separate header and
 192  *    "map_entry" structures.  This means that functions which modify a
 193  *    map no longer need to return a pointer to the modified map.
 194  *    Also, it no longer reverses the order of the entries (which may be
 195  *    important with some advanced template substitutions).
 196  *
 197  *    Revision 1.26  2001/07/30 22:08:36  jongfoster
 198  *    Tidying up #defines:
 199  *    - All feature #defines are now of the form FEATURE_xxx
 200  *    - Permanently turned off WIN_GUI_EDIT
 201  *    - Permanently turned on WEBDAV and SPLIT_PROXY_ARGS
 202  *
 203  *    Revision 1.25  2001/07/29 18:43:08  jongfoster
 204  *    Changing #ifdef _FILENAME_H to FILENAME_H_INCLUDED, to conform to
 205  *    ANSI C rules.
 206  *
 207  *    Revision 1.24  2001/07/25 17:20:27  oes
 208  *    Introduced http->user_agent
 209  *
 210  *    Revision 1.23  2001/07/18 12:32:23  oes
 211  *    - Added ACTION_STRING_DEANIMATE
 212  *    - moved #define freez from jcc.h to project.h
 213  *
 214  *    Revision 1.22  2001/07/15 17:51:41  jongfoster
 215  *    Renaming #define STATIC to STATIC_PCRE
 216  *
 217  *    Revision 1.21  2001/07/13 14:03:19  oes
 218  *     - Reorganized regex header inclusion and #defines to
 219  *       comply to the scheme in configure.in
 220  *     - Added csp->content_type and its CT_* keys
 221  *     - Added ACTION_DEANIMATE
 222  *     - Removed all #ifdef PCRS
 223  *
 224  *    Revision 1.20  2001/06/29 21:45:41  oes
 225  *    Indentation, CRLF->LF, Tab-> Space
 226  *
 227  *    Revision 1.19  2001/06/29 13:33:36  oes
 228  *    - Improved comments
 229  *    - Introduced http_request.host_ip_addr_str
 230  *    - Introduced http_response.head_length
 231  *    - Introduced config.my_ip_addr_str, config.my_hostname,
 232  *      config.admin_address and config.proxy_info_url
 233  *    - Removed config.proxy_args_header and config.proxy_args_trailer,
 234  *      renamed config.proxy_args_invocation to config.proxy_args
 235  *    - Removed HTML snipplets and GIFs
 236  *    - Removed logentry from cancelled commit
 237  *
 238  *    Revision 1.18  2001/06/09 10:57:39  jongfoster
 239  *    Adding definition of BUFFER_SIZE.
 240  *    Changing struct cgi_dispatcher to use "const" strings.
 241  *
 242  *    Revision 1.17  2001/06/07 23:15:09  jongfoster
 243  *    Merging ACL and forward files into config file.
 244  *    Moving struct gateway members into struct forward_spec
 245  *    Removing config->proxy_args_gateways
 246  *    Cosmetic: Adding a few comments
 247  *
 248  *    Revision 1.16  2001/06/04 18:31:58  swa
 249  *    files are now prefixed with either `confdir' or `logdir'.
 250  *    `make redhat-dist' replaces both entries confdir and logdir
 251  *    with redhat values
 252  *
 253  *    Revision 1.15  2001/06/04 11:28:53  swa
 254  *    redirect did not work due to missing /
 255  *
 256  *    Revision 1.14  2001/06/03 11:03:48  oes
 257  *    Added struct map,
 258  *    added struct http_response,
 259  *    changed struct interceptors to struct cgi_dispatcher,
 260  *    moved HTML stuff to cgi.h
 261  *
 262  *    Revision 1.13  2001/06/01 20:05:36  jongfoster
 263  *    Support for +image-blocker{}: added ACTION_IMAGE_BLOCKER
 264  *    constant, and removed csp->tinygif.
 265  *
 266  *    Revision 1.12  2001/06/01 18:49:17  jongfoster
 267  *    Replaced "list_share" with "list" - the tiny memory gain was not
 268  *    worth the extra complexity.
 269  *
 270  *    Revision 1.11  2001/06/01 10:32:47  oes
 271  *    Added constants for anchoring selection bitmap
 272  *
 273  *    Revision 1.10  2001/05/31 21:33:53  jongfoster
 274  *    Changes for new actions file, replacing permissionsfile
 275  *    and parts of the config file.  Also added support for
 276  *    list_shared.
 277  *
 278  *    Revision 1.9  2001/05/31 17:32:31  oes
 279  *
 280  *     - Enhanced domain part globbing with infix and prefix asterisk
 281  *       matching and optional unanchored operation
 282  *
 283  *    Revision 1.8  2001/05/29 20:09:15  joergs
 284  *    HTTP_REDIRECT_TEMPLATE fixed.
 285  *
 286  *    Revision 1.7  2001/05/29 09:50:24  jongfoster
 287  *    Unified blocklist/imagelist/actionslist.
 288  *    File format is still under discussion, but the internal changes
 289  *    are (mostly) done.
 290  *
 291  *    Also modified interceptor behaviour:
 292  *    - We now intercept all URLs beginning with one of the following
 293  *      prefixes (and *only* these prefixes):
 294  *        * http://i.j.b/
 295  *        * http://ijbswa.sf.net/config/
 296  *        * http://ijbswa.sourceforge.net/config/
 297  *    - New interceptors "home page" - go to http://i.j.b/ to see it.
 298  *    - Internal changes so that intercepted and fast redirect pages
 299  *      are not replaced with an image.
 300  *    - Interceptors now have the option to send a binary page direct
 301  *      to the client. (i.e. ijb-send-banner uses this)
 302  *    - Implemented show-url-info interceptor.  (Which is why I needed
 303  *      the above interceptors changes - a typical URL is
 304  *      "http://i.j.b/show-url-info?url=www.somesite.com/banner.gif".
 305  *      The previous mechanism would not have intercepted that, and
 306  *      if it had been intercepted then it then it would have replaced
 307  *      it with an image.)
 308  *
 309  *    Revision 1.6  2001/05/27 22:17:04  oes
 310  *
 311  *    - re_process_buffer no longer writes the modified buffer
 312  *      to the client, which was very ugly. It now returns the
 313  *      buffer, which it is then written by chat.
 314  *
 315  *    - content_length now adjusts the Content-Length: header
 316  *      for modified documents rather than crunch()ing it.
 317  *      (Length info in csp->content_length, which is 0 for
 318  *      unmodified documents)
 319  *
 320  *    - For this to work, sed() is called twice when filtering.
 321  *
 322  *    Revision 1.5  2001/05/26 00:28:36  jongfoster
 323  *    Automatic reloading of config file.
 324  *    Removed obsolete SIGHUP support (Unix) and Reload menu option (Win32).
 325  *    Most of the global variables have been moved to a new
 326  *    struct configuration_spec, accessed through csp->config->globalname
 327  *    Most of the globals remaining are used by the Win32 GUI.
 328  *
 329  *    Revision 1.4  2001/05/22 18:46:04  oes
 330  *
 331  *    - Enabled filtering banners by size rather than URL
 332  *      by adding patterns that replace all standard banner
 333  *      sizes with the "Junkbuster" gif to the re_filterfile
 334  *
 335  *    - Enabled filtering WebBugs by providing a pattern
 336  *      which kills all 1x1 images
 337  *
 338  *    - Added support for PCRE_UNGREEDY behaviour to pcrs,
 339  *      which is selected by the (nonstandard and therefore
 340  *      capital) letter 'U' in the option string.
 341  *      It causes the quantifiers to be ungreedy by default.
 342  *      Appending a ? turns back to greedy (!).
 343  *
 344  *    - Added a new interceptor ijb-send-banner, which
 345  *      sends back the "Junkbuster" gif. Without imagelist or
 346  *      MSIE detection support, or if tinygif = 1, or the
 347  *      URL isn't recognized as an imageurl, a lame HTML
 348  *      explanation is sent instead.
 349  *
 350  *    - Added new feature, which permits blocking remote
 351  *      script redirects and firing back a local redirect
 352  *      to the browser.
 353  *      The feature is conditionally compiled, i.e. it
 354  *      can be disabled with --disable-fast-redirects,
 355  *      plus it must be activated by a "fast-redirects"
 356  *      line in the config file, has its own log level
 357  *      and of course wants to be displayed by show-proxy-args
 358  *      Note: Boy, all the #ifdefs in 1001 locations and
 359  *      all the fumbling with configure.in and acconfig.h
 360  *      were *way* more work than the feature itself :-(
 361  *
 362  *    - Because a generic redirect template was needed for
 363  *      this, tinygif = 3 now uses the same.
 364  *
 365  *    - Moved GIFs, and other static HTTP response templates
 366  *      to project.h
 367  *
 368  *    - Some minor fixes
 369  *
 370  *    - Removed some >400 CRs again (Jon, you really worked
 371  *      a lot! ;-)
 372  *
 373  *    Revision 1.3  2001/05/20 01:21:20  jongfoster
 374  *    Version 2.9.4 checkin.
 375  *    - Merged popupfile and cookiefile, and added control over PCRS
 376  *      filtering, in new "actionsfile".
 377  *    - Implemented LOG_LEVEL_FATAL, so that if there is a configuration
 378  *      file error you now get a message box (in the Win32 GUI) rather
 379  *      than the program exiting with no explanation.
 380  *    - Made killpopup use the PCRS MIME-type checking and HTTP-header
 381  *      skipping.
 382  *    - Removed tabs from "config"
 383  *    - Moved duplicated url parsing code in "loaders.c" to a new funcition.
 384  *    - Bumped up version number.
 385  *
 386  *    Revision 1.2  2001/05/17 23:01:01  oes
 387  *     - Cleaned CRLF's from the sources and related files
 388  *
 389  *    Revision 1.1.1.1  2001/05/15 13:59:03  oes
 390  *    Initial import of version 2.9.3 source tree
 391  *
 392  *
 393  *********************************************************************/
 394 \f
 395
 396 /* Declare struct FILE for vars and funcs. */
 397 #include <stdio.h>
 398
 399 /* Need time_t for file_list */
 400 #include <time.h>
 401
 402 /*
 403  * Include appropriate regular expression libraries.
 404  * Note that pcrs and pcre (native) are needed for cgi
 405  * and are included anyway.
 406  */
 407
 408 #if defined(REGEX_PCRE) || defined (REGEX_GNU)
 409 # define REGEX
 410 #endif /* defined(REGEX_PCRE) || defined (REGEX_GNU) */
 411
 412 #ifdef STATIC_PCRE
 413 #  include "pcre.h"
 414 #else
 415 #  include <pcre.h>
 416 #endif
 417
 418 #ifdef STATIC_PCRS
 419 #  include "pcrs.h"
 420 #else
 421 #  include <pcrs.h>
 422 #endif
 423
 424 #if defined(REGEX_PCRE)
 425 #  ifdef STATIC_PCRE
 426 #    include "pcreposix.h"
 427 #  else
 428 #    include <pcreposix.h>
 429 #  endif
 430 #endif /* defined(REGEX_PCRE) */
 431
 432 #if defined(REGEX_GNU)
 433 #  include "gnu_regex.h"
 434 #endif
 435
 436 #ifdef AMIGA
 437 #include "amiga.h"
 438 #endif /* def AMIGA */
 439
 440 #ifdef _WIN32
 441 /*
 442  * I don't want to have to #include all this just for the declaration
 443  * of SOCKET.  However, it looks like we have to...
 444  */
 445 #include <windows.h>
 446 #endif
 447
 448
 449 #ifdef __cplusplus
 450 extern "C" {
 451 #endif
 452
 453 /*
 454  * The type used by sockets.  On UNIX it's an int.  Microsoft decided to
 455  * make it an unsigned.
 456  */
 457 #ifdef _WIN32
 458 typedef SOCKET jb_socket;
 459 #define JB_INVALID_SOCKET INVALID_SOCKET
 460 #else /* ndef _WIN32 */
 461 typedef int jb_socket;
 462 #define JB_INVALID_SOCKET (-1)
 463 #endif /* ndef _WIN32 */
 464
 465
 466 /*
 467  * Error codes.  Functions returning these should return a jb_err
 468  */
 469 #define JB_ERR_OK         0 /* Success, no error                        */
 470 #define JB_ERR_MEMORY     1 /* Out of memory                            */
 471 #define JB_ERR_CGI_PARAMS 2 /* Missing or corrupt CGI parameters        */
 472 #define JB_ERR_FILE       3 /* Error opening, reading or writing a file */
 473 #define JB_ERR_PARSE      4 /* Error parsing file                       */
 474 #define JB_ERR_MODIFIED   5 /* File has been modified outside of the    */
 475                             /* CGI actions editor.                      */
 476 typedef int jb_err;
 477
 478
 479 /*
 480  * This macro is used to free a pointer that may be NULL
 481  */
 482 #define freez(X)  { if(X) { free((void*)X); X = NULL ; } }
 483
 484
 485 /* Fix a problem with Solaris.  There should be no effect on other
 486  * platforms.
 487  * Solaris's isspace() is a macro which uses it's argument directly
 488  * as an array index.  Therefore we need to make sure that high-bit
 489  * characters generate +ve values, and ideally we also want to make
 490  * the argument match the declared parameter type of "int".
 491  *
 492  * Note: Remember to #include <ctype.h> if you use these macros.
 493  */
 494 #define ijb_toupper(__X) toupper((int)(unsigned char)(__X))
 495 #define ijb_tolower(__X) tolower((int)(unsigned char)(__X))
 496 #define ijb_isspace(__X) isspace((int)(unsigned char)(__X))
 497
 498 /*
 499  * Use for statically allocated buffers if you have no other choice.
 500  * Remember to check the length of what you write into the buffer
 501  * - we don't want any buffer overflows!
 502  */
 503 #define BUFFER_SIZE 5000
 504
 505 /*
 506  * Buffer size for capturing struct hostent data in the
 507  * gethostby(name|addr)_r library calls. Since we don't
 508  * loop over gethostbyname_r, the buffer must be sufficient
 509  * to accomodate multiple IN A RRs, as used in DNS round robin
 510  * load balancing. W3C's wwwlib uses 1K, so that should be
 511  * good enough for us, too.
 512  */
 513 #define HOSTENT_BUFFER_SIZE 1024
 514
 515 /*
 516  * So you can say "while (FOREVER) { ...do something... }"
 517  */
 518 #define FOREVER 1
 519
 520 /* Default IP and port to listen on */
 521 #define HADDR_DEFAULT   "127.0.0.1"
 522 #define HADDR_PORT      8118
 523
 524 /* Forward defs for various structures */
 525
 526 /* Need this for struct client_state */
 527 struct configuration_spec;
 528
 529
 530 /* Generic linked list of strings */
 531
 532 struct list_entry
 533 {
 534    const char *str;
 535    struct list_entry *next;
 536 };
 537
 538 struct list
 539 {
 540    struct list_entry *first;
 541    struct list_entry *last;
 542 };
 543
 544
 545 /* A map from a string to another string */
 546
 547 struct map_entry
 548 {
 549    const char *name;
 550    const char *value;
 551    struct map_entry *next;
 552 };
 553
 554 struct map
 555 {
 556    struct map_entry *first;
 557    struct map_entry *last;
 558 };
 559
 560
 561 struct http_request
 562 {
 563    char *cmd;      /* Whole command line: method, URL, Version */
 564    char *ocmd;     /* Backup of original cmd for CLF logging */
 565    char *gpc;      /* HTTP method: GET, POST, .. */
 566    char *url;      /* The URL */
 567    char *ver;      /* Protocol version */
 568    int status;     /* HTTP Status */
 569
 570    char *host;     /* Host part of URL */
 571    int   port;     /* Port of URL or 80 (default) */
 572    char *path;     /* Path of URL */
 573    char *hostport; /* host[:port] */
 574    int   ssl;      /* Flag if protocol is https */
 575
 576    char *host_ip_addr_str; /* String with dotted decimal representation
 577                             * of host's IP. NULL before connect_to() */
 578
 579    char  *dbuffer;     /* Buffer with '\0'-delimited domain name.           */
 580    char **dvec;        /* List of pointers to the strings in dbuffer.       */
 581    int    dcount;      /* How many parts to this domain? (length of dvec)   */
 582 };
 583
 584 /*
 585  * Response generated by CGI, blocker, or error handler
 586  */
 587 struct http_response
 588 {
 589   char  *status;          /* HTTP status (string) */
 590   struct list headers[1]; /* List of header lines */
 591   char  *head;            /* Formatted http response head */
 592   size_t head_length;     /* Length of http response head */
 593   char  *body;            /* HTTP document body */
 594   size_t content_length;  /* Length of body, REQUIRED if binary body */
 595   int    is_static;       /* Nonzero if the content will never change and
 596                            * should be cached by the brwoser (e.g. images) */
 597 };
 598
 599 /* A URL pattern */
 600 struct url_spec
 601 {
 602    char  *spec;        /* The string which was parsed to produce this       */
 603                        /* url_spec.  Used for debugging or display only.    */
 604
 605    /* Hostname matching, or dbuffer == NULL to match all hosts */
 606    char  *dbuffer;     /* Buffer with '\0'-delimited domain name.           */
 607    char **dvec;        /* List of pointers to the strings in dbuffer.       */
 608    int    dcount;      /* How many parts to this domain? (length of dvec)   */
 609    int    unanchored;  /* Bitmap - flags are ANCHOR_LEFT and ANCHOR_RIGHT.  */
 610
 611    /* Port matching: */
 612    int   port;         /* The port number, or 0 to match all ports.         */
 613
 614    /* Path matching: */
 615    char *path;         /* The path prefix (if not using regex), or source   */
 616                        /* for the regex.                                    */
 617    int   pathlen;      /* ==strlen(path).  Needed for prefix matching.      */
 618 #ifdef REGEX
 619    regex_t *preg;      /* Regex for matching path part                      */
 620 #endif
 621 };
 622 #ifdef REGEX
 623 #define URL_SPEC_INITIALIZER { NULL, NULL, NULL, 0, 0, 0, NULL, 0, NULL }
 624 #else /* ifndef REGEX */
 625 #define URL_SPEC_INITIALIZER { NULL, NULL, NULL, 0, 0, 0, NULL, 0 }
 626 #endif /* ndef REGEX */
 627
 628 /* Constants for host part matching in URLs */
 629 #define ANCHOR_LEFT  1
 630 #define ANCHOR_RIGHT 2
 631
 632
 633 /* An I/O buffer */
 634 struct iob
 635 {
 636    char *buf;
 637    char *cur;
 638    char *eod;
 639 };
 640
 641
 642 #define IOB_PEEK(CSP) ((CSP->iob->cur > CSP->iob->eod) ? (CSP->iob->eod - CSP->iob->cur) : 0)
 643 #define IOB_RESET(CSP) if(CSP->iob->buf) free(CSP->iob->buf); memset(CSP->iob, '\0', sizeof(CSP->iob));
 644
 645 /* Bits for csp->content_type */
 646 #define CT_TEXT   1 /* Suitable for pcrs filtering */
 647 #define CT_GIF    2 /* Suitable for GIF filtering */
 648 #define CT_TABOO  4 /* DONT filter */
 649
 650 #define ACTION_MASK_ALL        (~0U)
 651
 652 #define ACTION_MOST_COMPATIBLE 0x00000000UL
 653
 654 #define ACTION_BLOCK           0x00000001UL
 655 #define ACTION_DEANIMATE       0x00000002UL
 656 #define ACTION_DOWNGRADE       0x00000004UL
 657 #define ACTION_FAST_REDIRECTS  0x00000008UL
 658 #define ACTION_HIDE_FORWARDED  0x00000010UL
 659 #define ACTION_HIDE_FROM       0x00000020UL
 660 #define ACTION_HIDE_REFERER    0x00000040UL /* sic - follow HTTP, not English */
 661 #define ACTION_HIDE_USER_AGENT 0x00000080UL
 662 #define ACTION_IMAGE           0x00000100UL
 663 #define ACTION_IMAGE_BLOCKER   0x00000200UL
 664 #define ACTION_NO_COMPRESSION  0x00000400UL
 665 #define ACTION_NO_COOKIE_KEEP  0x00000800UL
 666 #define ACTION_NO_COOKIE_READ  0x00001000UL
 667 #define ACTION_NO_COOKIE_SET   0x00002000UL
 668 #define ACTION_NO_POPUPS       0x00004000UL
 669 #define ACTION_VANILLA_WAFER   0x00008000UL
 670 #define ACTION_LIMIT_CONNECT   0x00010000UL
 671
 672 #define ACTION_STRING_DEANIMATE     0
 673 #define ACTION_STRING_FROM          1
 674 #define ACTION_STRING_IMAGE_BLOCKER 2
 675 #define ACTION_STRING_REFERER       3
 676 #define ACTION_STRING_USER_AGENT    4
 677 #define ACTION_STRING_LIMIT_CONNECT 5
 678 #define ACTION_STRING_COUNT         6
 679
 680 #define ACTION_MULTI_ADD_HEADER     0
 681 #define ACTION_MULTI_WAFER          1
 682 #define ACTION_MULTI_FILTER         2
 683 #define ACTION_MULTI_COUNT          3
 684
 685
 686 /*
 687  * This structure contains a list of actions to apply to a URL.
 688  * It only contains positive instructions - no "-" options.
 689  * It is not used to store the actions list itself, only for
 690  * url_actions() to return the current values.
 691  */
 692 struct current_action_spec
 693 {
 694    unsigned long flags;    /* a bit set to "1" = add action    */
 695
 696    /* For those actions that require parameters: */
 697
 698    /* each entry is valid if & only if corresponding entry in "add" set. */
 699    char * string[ACTION_STRING_COUNT];
 700
 701    /* Strings to add */
 702    struct list multi[ACTION_MULTI_COUNT][1];
 703 };
 704
 705
 706 /*
 707  * This structure contains a set of changes to actions.
 708  * It can contain both positive and negative instructions.
 709  * It is used to store an entry in the actions list.
 710  */
 711 struct action_spec
 712 {
 713    unsigned long mask;   /* a bit set to "0" = remove action */
 714    unsigned long add;    /* a bit set to "1" = add action    */
 715
 716    /* For those actions that require parameters: */
 717
 718    /* each entry is valid if & only if corresponding entry in "add" set. */
 719    char * string[ACTION_STRING_COUNT];
 720
 721    /* Strings to remove. */
 722    struct list multi_remove[ACTION_MULTI_COUNT][1];
 723
 724    /* If nonzero, remove *all* strings. */
 725    int         multi_remove_all[ACTION_MULTI_COUNT];
 726
 727    /* Strings to add */
 728    struct list multi_add[ACTION_MULTI_COUNT][1];
 729 };
 730
 731 /*
 732  * This structure is used to store the actions list.
 733  *
 734  * It contains a URL pattern, and the chages to the actions.
 735  * It is a linked list.
 736  */
 737 struct url_actions
 738 {
 739    struct url_spec url[1];
 740
 741    struct action_spec action[1];
 742
 743    struct url_actions * next;
 744 };
 745
 746
 747 /*
 748  * Flags for use in csp->flags
 749  */
 750 #define CSP_FLAG_ACTIVE     0x01 /* Set if this client is processing data.
 751                                   * Cleared when the thread associated with
 752                                   * this structure dies. */
 753 #define CSP_FLAG_CHUNKED    0x02 /* Set if the server's reply is in "chunked"
 754                                   * transfer encoding */
 755 #define CSP_FLAG_FORCED     0x04 /* Set if this request was enforced, although
 756                                   * it would normally have been blocked. */
 757 #define CSP_FLAG_MODIFIED   0x08 /* Set if any modification to the body was done */
 758 #define CSP_FLAG_REJECTED   0x10 /* Set if request was blocked.  */
 759 #define CSP_FLAG_TOGGLED_ON 0x20 /* Set if we are toggled on (FEATURE_TOGGLE) */
 760
 761 /*
 762  * The state of a JunkBuster processing thread.
 763  */
 764 struct client_state
 765 {
 766    /* The proxy's configuration */
 767    struct configuration_spec * config;
 768
 769    /* The actions to perform on the current request */
 770    struct current_action_spec  action[1];
 771
 772    /* socket to talk to client (web browser) */
 773    jb_socket cfd;
 774
 775    /* socket to talk to server (web server or proxy) */
 776    jb_socket sfd;
 777
 778    /* Multi-purpose flag container, see CSP_FLAG_* above */
 779    unsigned short int flags;
 780
 781    /*
 782     * Client PC's IP address, as reported by the accept()_ function.
 783     * Both as string and number
 784     */
 785    char *ip_addr_str;
 786    long  ip_addr_long;
 787
 788
 789    /* Our IP address and hostname, i.e. the IP address that
 790       the client used to reach us, and the associated hostname,
 791       both as strings
 792     */
 793    char *my_ip_addr_str;
 794    char *my_hostname;
 795
 796    /* The URL that was requested */
 797    struct http_request http[1];
 798
 799    /* An I/O buffer used for buffering data read from the client */
 800    struct iob iob[1];
 801
 802    /* List of all headers for this request */
 803    struct list headers[1];
 804
 805    /* List of all cookies for this request */
 806    struct list cookie_list[1];
 807
 808    /* MIME-Type key, see CT_* above */
 809    unsigned short int content_type;
 810
 811    /* The "X-Forwarded-For:" header sent by the client */
 812    char   *x_forwarded;
 813
 814    /* files associated with this client */
 815    struct file_list *actions_list;
 816
 817    struct file_list *rlist;   /* pcrs job file */
 818    size_t content_length;     /* Length after content modification */
 819
 820 #ifdef FEATURE_TRUST
 821    struct file_list *tlist;   /* trustfile */
 822 #endif /* def FEATURE_TRUST */
 823
 824    struct client_state *next;
 825 };
 826
 827
 828 /*
 829  * A function to add a header
 830  */
 831 typedef jb_err (*add_header_func_ptr)(struct client_state *);
 832
 833 /*
 834  * A function to process a header
 835  */
 836 typedef jb_err (*parser_func_ptr    )(struct client_state *, char **);
 837
 838 /*
 839  * List of functions to run on a list of headers
 840  */
 841 struct parsers
 842 {
 843    char   *str;
 844    size_t len;
 845    parser_func_ptr parser;
 846 };
 847
 848
 849 /*
 850  * List of available CGI functions.
 851  */
 852 struct cgi_dispatcher
 853 {
 854    const char * const name;
 855    jb_err    (* const handler)(struct client_state *csp, struct http_response *rsp, const struct map *parameters);
 856    const char * const description;
 857 };
 858
 859
 860 /*
 861  * A data file used by JunkBuster.  Kept in a linked list.
 862  */
 863 struct file_list
 864 {
 865    /*
 866     * this is a pointer to the data structures associated with the file.
 867     * Read-only once the structure has been created.
 868     */
 869    void *f;
 870
 871    /* Normally NULL.  When we are finished with file (i.e. when we have
 872     * loaded a new one), set to a pointer to an unloader function.
 873     * Unloader will be called by sweep() (called from main loop) when
 874     * all clients using this file are done.  This prevents threading
 875     * problems.
 876     */
 877    void (*unloader)(void *);
 878
 879    /* Used internally by sweep().  Do not access from elsewhere. */
 880    int active;
 881
 882    /* Following variables allow us to check if file has been changed.
 883     * Read-only once the structure has been created.
 884     */
 885    time_t lastmodified;
 886    char * filename;
 887
 888    /* Pointer to next entry in the linked list of all "file_list"s.
 889     * This linked list is so that sweep() can navigate it.
 890     * Since sweep() can remove items from the list, we must be careful
 891     * to only access this value from main thread (when we know sweep
 892     * won't be running).
 893     */
 894    struct file_list *next;
 895 };
 896
 897
 898 #ifdef FEATURE_TRUST
 899 struct block_spec
 900 {
 901    struct url_spec url[1];
 902    int    reject;
 903    struct block_spec *next;
 904 };
 905 #endif /* def FEATURE_TRUST */
 906
 907
 908 #define SOCKS_NONE    0    /* Don't use a SOCKS server */
 909 #define SOCKS_4      40    /* original SOCKS 4 protocol */
 910 #define SOCKS_4A     41    /* as modified for hosts w/o external DNS */
 911
 912 struct forward_spec
 913 {
 914    struct url_spec url[1];
 915
 916    /* Connection type - must be a SOCKS_xxx constant */
 917    int   type;
 918
 919    /* SOCKS server */
 920    char *gateway_host;
 921    int   gateway_port;
 922
 923    /* Parent HTTP proxy */
 924    char *forward_host;
 925    int   forward_port;
 926
 927    /* For the linked list */
 928    struct forward_spec *next;
 929 };
 930 #define FORWARD_SPEC_INITIALIZER { { URL_SPEC_INITIALIZER }, 0, NULL, 0, NULL, 0, NULL }
 931
 932
 933 /*
 934  * This struct represents one filter (one block) from
 935  * the re_filterfile. If there is more than one filter
 936  * in the file, the file will be represented by a
 937  * chained list of re_filterfile specs.
 938  */
 939 struct re_filterfile_spec
 940 {
 941    char *name;                      /* Name from FILTER: statement in re_filterfile */
 942    char *description;               /* Description from FILTER: statement in re_filterfile */
 943    struct list patterns[1];         /* The patterns from the re_filterfile */
 944    pcrs_job *joblist;               /* The resulting compiled pcrs_jobs */
 945    struct re_filterfile_spec *next; /* The pointer for chaining */
 946 };
 947
 948 #ifdef FEATURE_ACL
 949 #define ACL_PERMIT   1  /* accept connection request */
 950 #define ACL_DENY     2  /* reject connection request */
 951
 952 struct access_control_addr
 953 {
 954    unsigned long addr;
 955    unsigned long mask;
 956    unsigned long port;
 957 };
 958
 959 struct access_control_list
 960 {
 961    struct access_control_addr src[1];
 962    struct access_control_addr dst[1];
 963
 964    short action;
 965    struct access_control_list *next;
 966 };
 967 #endif /* def FEATURE_ACL */
 968
 969
 970 /* Maximum number of loaders (actions, re_filter, ...) */
 971 #define NLOADERS 8
 972
 973
 974 #define RUNTIME_FEATURE_CGI_EDIT_ACTIONS  1
 975 #define RUNTIME_FEATURE_CGI_TOGGLE        2
 976
 977
 978 /*
 979  * Data loaded from the configuration file.
 980  *
 981  * (Anomaly: toggle is still handled through a global, not this structure)
 982  */
 983 struct configuration_spec
 984 {
 985    int debug;
 986    int multi_threaded;
 987
 988    /* Features that can be enabled/disabled throuigh the config file */
 989    unsigned feature_flags;
 990
 991    const char *logfile;
 992
 993    const char *confdir;
 994    const char *logdir;
 995    const char *actions_file;
 996
 997    /* The administrator's email address */
 998    char *admin_address;
 999
1000    /* A URL with info on this proxy */
1001    char *proxy_info_url;
1002
1003    const char *re_filterfile;
1004
1005 #ifdef FEATURE_COOKIE_JAR
1006    const char * jarfile;
1007    FILE * jar;
1008 #endif /* def FEATURE_COOKIE_JAR */
1009
1010    /*
1011     * Port and IP to bind to.
1012     * Defaults to HADDR_DEFAULT:HADDR_PORT == 127.0.0.1:8118
1013     */
1014    const char *haddr;
1015    int         hport;
1016
1017    /* Size limit for IOB */
1018    size_t buffer_limit;
1019
1020 #ifdef FEATURE_TRUST
1021    const char * trustfile;
1022
1023    struct list trust_info[1];
1024    struct url_spec *trust_list[64];
1025 #endif /* def FEATURE_TRUST */
1026
1027 #ifdef FEATURE_ACL
1028    struct access_control_list *acl;
1029 #endif /* def FEATURE_ACL */
1030
1031    struct forward_spec *forward;
1032
1033    /* All options from the config file, HTML-formatted */
1034    char *proxy_args;
1035
1036    /* the configuration file object. */
1037    struct file_list *config_file_list;
1038
1039    /* List of loaders */
1040    int (*loaders[NLOADERS])(struct client_state *);
1041
1042    /* bool, nonzero if we need to bind() to the new port */
1043    int need_bind;
1044 };
1045
1046
1047 #define SZ(X)  (sizeof(X) / sizeof(*X))
1048
1049 #ifdef FEATURE_FORCE_LOAD
1050 #define FORCE_PREFIX "/IJB-FORCE-LOAD"
1051 #endif /* def FEATURE_FORCE_LOAD */
1052
1053 #ifdef FEATURE_NO_GIFS
1054 #define BUILTIN_IMAGE_MIMETYPE "image/png"
1055 #else
1056 #define BUILTIN_IMAGE_MIMETYPE "image/gif"
1057 #endif /* def FEATURE_NO_GIFS */
1058
1059
1060 /* Hardwired URLs */
1061 #define HOME_PAGE_URL       "http://ijbswa.sourceforge.net"
1062 #define REDIRECT_URL        HOME_PAGE_URL "/redirect.php?v=" VERSION "&to="
1063
1064 /*
1065  * The "hosts" to intercept and display CGI pages.
1066  * First one is a hostname only, second one can specify host and path.
1067  *
1068  * Notes:
1069  * 1) Do not specify the http: prefix
1070  * 2) CGI_SITE_2_PATH must not end with /, one will be added automatically.
1071  * 3) CGI_SITE_2_PATH must start with /, unless it is the empty string.
1072  */
1073 #define CGI_SITE_1_HOST "i.j.b"
1074 #define CGI_SITE_2_HOST "ijbswa.sourceforge.net"
1075 #define CGI_SITE_2_PATH "/config"
1076
1077 /*
1078  * The prefix for CGI pages.  Written out in generated HTML.
1079  * INCLUDES the trailing slash.
1080  */
1081 #define CGI_PREFIX  "http://" CGI_SITE_2_HOST CGI_SITE_2_PATH "/"
1082
1083
1084 /* HTTP snipplets */
1085 static const char CSUCCEED[] =
1086    "HTTP/1.0 200 Connection established\n"
1087    "Proxy-Agent: IJ/" VERSION "\r\n\r\n";
1088
1089 static const char CHEADER[] =
1090    "HTTP/1.0 400 Invalid header received from browser\r\n\r\n";
1091
1092 static const char CFORBIDDEN[] =
1093    "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";
1094
1095 #ifdef __cplusplus
1096 } /* extern "C" */
1097 #endif
1098
1099 #endif /* ndef PROJECT_H_INCLUDED */
1100
1101 /*
1102   Local Variables:
1103   tab-width: 3
1104   end:
1105 */