project.h

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