project.h

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