project.h

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