project.h

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