project.h

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