src/filters.h

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