project.h

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