project.h

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