project.h

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