project.h

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