filters.h

   1 #ifndef FILTERS_H_INCLUDED
   2 #define FILTERS_H_INCLUDED
   3 #define FILTERS_H_VERSION "$Id: filters.h,v 1.19 2002/03/26 22:29:54 swa Exp $"
   4 /*********************************************************************
   5  *
   6  * File        :  $Source: /cvsroot/ijbswa/current/filters.h,v $
   7  *
   8  * Purpose     :  Declares functions to parse/crunch headers and pages.
   9  *                Functions declared include:
  10  *                   `acl_addr', `add_stats', `block_acl', `block_imageurl',
  11  *                   `block_url', `url_actions', `filter_popups', `forward_url'
  12  *                   `ij_untrusted_url', `intercept_url', `re_process_buffer',
  13  *                   `show_proxy_args', and `trust_url'
  14  *
  15  * Copyright   :  Written by and Copyright (C) 2001 the SourceForge
  16  *                Privoxy team. http://www.privoxy.org/
  17  *
  18  *                Based on the Internet Junkbuster originally written
  19  *                by and Copyright (C) 1997 Anonymous Coders and
  20  *                Junkbusters Corporation.  http://www.junkbusters.com
  21  *
  22  *                This program is free software; you can redistribute it
  23  *                and/or modify it under the terms of the GNU General
  24  *                Public License as published by the Free Software
  25  *                Foundation; either version 2 of the License, or (at
  26  *                your option) any later version.
  27  *
  28  *                This program is distributed in the hope that it will
  29  *                be useful, but WITHOUT ANY WARRANTY; without even the
  30  *                implied warranty of MERCHANTABILITY or FITNESS FOR A
  31  *                PARTICULAR PURPOSE.  See the GNU General Public
  32  *                License for more details.
  33  *
  34  *                The GNU General Public License should be included with
  35  *                this file.  If not, you can view it at
  36  *                http://www.gnu.org/copyleft/gpl.html
  37  *                or write to the Free Software Foundation, Inc., 59
  38  *                Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  39  *
  40  * Revisions   :
  41  *    $Log: filters.h,v $
  42  *    Revision 1.19  2002/03/26 22:29:54  swa
  43  *    we have a new homepage!
  44  *
  45  *    Revision 1.18  2002/03/25 22:12:45  oes
  46  *    Added fix for undefined INADDR_NONE on Solaris by Bart Schelstraete
  47  *
  48  *    Revision 1.17  2002/03/24 13:25:43  swa
  49  *    name change related issues
  50  *
  51  *    Revision 1.16  2002/01/17 21:01:02  jongfoster
  52  *    Moving all our URL and URL pattern parsing code to urlmatch.c.
  53  *
  54  *    Revision 1.15  2001/10/10 16:44:16  oes
  55  *    Added match_portlist function
  56  *
  57  *    Revision 1.14  2001/10/07 15:41:40  oes
  58  *    Added prototype for remove_chunked_transfer_coding
  59  *
  60  *    Revision 1.13  2001/07/30 22:08:36  jongfoster
  61  *    Tidying up #defines:
  62  *    - All feature #defines are now of the form FEATURE_xxx
  63  *    - Permanently turned off WIN_GUI_EDIT
  64  *    - Permanently turned on WEBDAV and SPLIT_PROXY_ARGS
  65  *
  66  *    Revision 1.12  2001/07/29 19:01:11  jongfoster
  67  *    Changed _FILENAME_H to FILENAME_H_INCLUDED.
  68  *    Added forward declarations for needed structures.
  69  *
  70  *    Revision 1.11  2001/07/13 14:00:18  oes
  71  *     - Introduced gif_deanimate_response
  72  *     - Renamed re_process_buffer to pcrs_filter_response
  73  *     - Removed all #ifdef PCRS
  74  *
  75  *    Revision 1.10  2001/06/29 13:29:01  oes
  76  *    Cleaned up and updated to reflect the changesin
  77  *    filters.c
  78  *
  79  *    Revision 1.9  2001/06/07 23:10:53  jongfoster
  80  *    Replacing struct gateway with struct forward_spec
  81  *
  82  *    Revision 1.8  2001/06/03 19:12:00  oes
  83  *    extracted-CGI relevant stuff
  84  *
  85  *    Revision 1.7  2001/05/31 21:21:30  jongfoster
  86  *    Permissionsfile / actions file changes:
  87  *    - Changed "permission" to "action" throughout
  88  *    - changes to file format to allow string parameters
  89  *    - Moved helper functions to actions.c
  90  *
  91  *    Revision 1.6  2001/05/29 09:50:24  jongfoster
  92  *    Unified blocklist/imagelist/permissionslist.
  93  *    File format is still under discussion, but the internal changes
  94  *    are (mostly) done.
  95  *
  96  *    Also modified interceptor behaviour:
  97  *    - We now intercept all URLs beginning with one of the following
  98  *      prefixes (and *only* these prefixes):
  99  *        * http://i.j.b/
 100  *        * http://ijbswa.sf.net/config/
 101  *        * http://ijbswa.sourceforge.net/config/
 102  *    - New interceptors "home page" - go to http://i.j.b/ to see it.
 103  *    - Internal changes so that intercepted and fast redirect pages
 104  *      are not replaced with an image.
 105  *    - Interceptors now have the option to send a binary page direct
 106  *      to the client. (i.e. ijb-send-banner uses this)
 107  *    - Implemented show-url-info interceptor.  (Which is why I needed
 108  *      the above interceptors changes - a typical URL is
 109  *      "http://i.j.b/show-url-info?url=www.somesite.com/banner.gif".
 110  *      The previous mechanism would not have intercepted that, and
 111  *      if it had been intercepted then it then it would have replaced
 112  *      it with an image.)
 113  *
 114  *    Revision 1.5  2001/05/27 22:17:04  oes
 115  *
 116  *    - re_process_buffer no longer writes the modified buffer
 117  *      to the client, which was very ugly. It now returns the
 118  *      buffer, which it is then written by chat.
 119  *
 120  *    - content_length now adjusts the Content-Length: header
 121  *      for modified documents rather than crunch()ing it.
 122  *      (Length info in csp->content_length, which is 0 for
 123  *      unmodified documents)
 124  *
 125  *    - For this to work, sed() is called twice when filtering.
 126  *
 127  *    Revision 1.4  2001/05/26 15:26:15  jongfoster
 128  *    ACL feature now provides more security by immediately dropping
 129  *    connections from untrusted hosts.
 130  *
 131  *    Revision 1.3  2001/05/22 18:46:04  oes
 132  *
 133  *    - Enabled filtering banners by size rather than URL
 134  *      by adding patterns that replace all standard banner
 135  *      sizes with the "Junkbuster" gif to the re_filterfile
 136  *
 137  *    - Enabled filtering WebBugs by providing a pattern
 138  *      which kills all 1x1 images
 139  *
 140  *    - Added support for PCRE_UNGREEDY behaviour to pcrs,
 141  *      which is selected by the (nonstandard and therefore
 142  *      capital) letter 'U' in the option string.
 143  *      It causes the quantifiers to be ungreedy by default.
 144  *      Appending a ? turns back to greedy (!).
 145  *
 146  *    - Added a new interceptor ijb-send-banner, which
 147  *      sends back the "Junkbuster" gif. Without imagelist or
 148  *      MSIE detection support, or if tinygif = 1, or the
 149  *      URL isn't recognized as an imageurl, a lame HTML
 150  *      explanation is sent instead.
 151  *
 152  *    - Added new feature, which permits blocking remote
 153  *      script redirects and firing back a local redirect
 154  *      to the browser.
 155  *      The feature is conditionally compiled, i.e. it
 156  *      can be disabled with --disable-fast-redirects,
 157  *      plus it must be activated by a "fast-redirects"
 158  *      line in the config file, has its own log level
 159  *      and of course wants to be displayed by show-proxy-args
 160  *      Note: Boy, all the #ifdefs in 1001 locations and
 161  *      all the fumbling with configure.in and acconfig.h
 162  *      were *way* more work than the feature itself :-(
 163  *
 164  *    - Because a generic redirect template was needed for
 165  *      this, tinygif = 3 now uses the same.
 166  *
 167  *    - Moved GIFs, and other static HTTP response templates
 168  *      to project.h
 169  *
 170  *    - Some minor fixes
 171  *
 172  *    - Removed some >400 CRs again (Jon, you really worked
 173  *      a lot! ;-)
 174  *
 175  *    Revision 1.2  2001/05/20 01:21:20  jongfoster
 176  *    Version 2.9.4 checkin.
 177  *    - Merged popupfile and cookiefile, and added control over PCRS
 178  *      filtering, in new "permissionsfile".
 179  *    - Implemented LOG_LEVEL_FATAL, so that if there is a configuration
 180  *      file error you now get a message box (in the Win32 GUI) rather
 181  *      than the program exiting with no explanation.
 182  *    - Made killpopup use the PCRS MIME-type checking and HTTP-header
 183  *      skipping.
 184  *    - Removed tabs from "config"
 185  *    - Moved duplicated url parsing code in "loaders.c" to a new funcition.
 186  *    - Bumped up version number.
 187  *
 188  *    Revision 1.1.1.1  2001/05/15 13:58:52  oes
 189  *    Initial import of version 2.9.3 source tree
 190  *
 191  *
 192  *********************************************************************/
 193 \f
 194
 195 #include "project.h"
 196
 197 #ifdef __cplusplus
 198 extern "C" {
 199 #endif
 200
 201
 202 struct access_control_addr;
 203 struct client_state;
 204 struct http_request;
 205 struct http_response;
 206 struct current_action_spec;
 207 struct url_actions;
 208 struct url_spec;
 209
 210
 211 /*
 212  * ACL checking
 213  */
 214 #ifdef FEATURE_ACL
 215 extern int block_acl(struct access_control_addr *dst, struct client_state *csp);
 216 extern int acl_addr(char *aspec, struct access_control_addr *aca);
 217 #endif /* def FEATURE_ACL */
 218 extern int match_portlist(const char *portlist, int port);
 219
 220 /*
 221  * Interceptors
 222  */
 223 extern struct http_response *block_url(struct client_state *csp);
 224 extern struct http_response *redirect_url(struct client_state *csp);
 225 #ifdef FEATURE_TRUST
 226 extern struct http_response *trust_url(struct client_state *csp);
 227 #endif /* def FEATURE_TRUST */
 228
 229 /*
 230  * Request inspectors
 231  */
 232 #ifdef FEATURE_TRUST
 233 extern int is_untrusted_url(struct client_state *csp);
 234 #endif /* def FEATURE_TRUST */
 235 #ifdef FEATURE_IMAGE_BLOCKING
 236 extern int is_imageurl(struct client_state *csp);
 237 #endif /* def FEATURE_IMAGE_BLOCKING */
 238
 239 /*
 240  * Determining applicable actions
 241  */
 242 extern void url_actions(struct http_request *http,
 243                         struct client_state *csp);
 244 extern void apply_url_actions(struct current_action_spec *action,
 245                               struct http_request *http,
 246                               struct url_actions *b);
 247 /*
 248  * Determining parent proxies
 249  */
 250 extern const struct forward_spec *forward_url(struct http_request *http, struct client_state *csp);
 251
 252 /*
 253  * Content modification
 254  */
 255 extern char *pcrs_filter_response(struct client_state *csp);
 256 extern char *gif_deanimate_response(struct client_state *csp);
 257 extern int remove_chunked_transfer_coding(char *buffer, const size_t size);
 258
 259 /*
 260  * Solaris fix:
 261  */
 262 #ifndef INADDR_NONE
 263 #define INADDR_NONE -1
 264 #endif
 265
 266 /*
 267  * Revision control strings from this header and associated .c file
 268  */
 269 extern const char filters_rcs[];
 270 extern const char filters_h_rcs[];
 271
 272 #ifdef __cplusplus
 273 } /* extern "C" */
 274 #endif
 275
 276 #endif /* ndef FILTERS_H_INCLUDED */
 277
 278 /*
 279   Local Variables:
 280   tab-width: 3
 281   end:
 282 */