project.h

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