project.h

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