project.h

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