project.h

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