1 #ifndef FILTERS_H_INCLUDED
2 #define FILTERS_H_INCLUDED
3 #define FILTERS_H_VERSION "$Id: filters.h,v 1.33 2008/02/23 16:57:12 fabiankeil Exp $"
4 /*********************************************************************
6 * File : $Source: /cvsroot/ijbswa/current/filters.h,v $
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'
15 * Copyright : Written by and Copyright (C) 2001, 2004 the SourceForge
16 * Privoxy team. http://www.privoxy.org/
18 * Based on the Internet Junkbuster originally written
19 * by and Copyright (C) 1997 Anonymous Coders and
20 * Junkbusters Corporation. http://www.junkbusters.com
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.
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.
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.
42 * Revision 1.33 2008/02/23 16:57:12 fabiankeil
43 * Rename url_actions() to get_url_actions() and let it
44 * use the standard parameter ordering.
46 * Revision 1.32 2008/02/23 16:33:43 fabiankeil
47 * Let forward_url() use the standard parameter ordering
48 * and mark its second parameter immutable.
50 * Revision 1.31 2007/10/19 16:53:28 fabiankeil
51 * Add helper function to check if any content filters are enabled.
53 * Revision 1.30 2007/09/29 10:21:16 fabiankeil
54 * - Move get_filter_function() from jcc.c to filters.c
55 * so the filter functions can be static.
56 * - Don't bother filtering body-less responses.
58 * Revision 1.29 2007/09/28 16:38:55 fabiankeil
59 * - Execute content filters through execute_content_filter().
60 * - Add prepare_for_filtering() so filter functions don't have to
61 * care about de-chunking and decompression. As a side effect this enables
62 * decompression for gif_deanimate_response() and jpeg_inspect_response().
63 * - Change remove_chunked_transfer_coding()'s return type to jb_err.
64 * Some clowns feel like chunking empty responses in which case
65 * (size == 0) is valid but previously would be interpreted as error.
67 * Revision 1.28 2007/09/02 15:31:20 fabiankeil
68 * Move match_portlist() from filter.c to urlmatch.c.
69 * It's used for url matching, not for filtering.
71 * Revision 1.27 2007/04/30 15:02:18 fabiankeil
72 * Introduce dynamic pcrs jobs that can resolve variables.
74 * Revision 1.26 2007/03/13 11:28:43 fabiankeil
75 * - Fix port handling in acl_addr() and use a temporary acl spec
76 * copy so error messages don't contain a truncated version.
77 * - Log size of iob before and after decompression.
79 * Revision 1.25 2007/01/12 15:36:44 fabiankeil
80 * Mark *csp as immutable for is_untrusted_url()
81 * and is_imageurl(). Closes FR 1237736.
83 * Revision 1.24 2006/12/29 18:30:46 fabiankeil
84 * Fixed gcc43 conversion warnings,
85 * changed sprintf calls to snprintf.
87 * Revision 1.23 2006/11/28 15:19:43 fabiankeil
88 * Implemented +redirect{s@foo@bar@} to generate
89 * a redirect based on a rewritten version of the
92 * Revision 1.22 2006/07/18 14:48:46 david__schmidt
93 * Reorganizing the repository: swapping out what was HEAD (the old 3.1 branch)
94 * with what was really the latest development (the v_3_0_branch branch)
96 * Revision 1.20.2.2 2004/10/03 12:53:32 david__schmidt
97 * Add the ability to check jpeg images for invalid
98 * lengths of comment blocks. Defensive strategy
99 * against the exploit:
100 * Microsoft Security Bulletin MS04-028
101 * Buffer Overrun in JPEG Processing (GDI+) Could
102 * Allow Code Execution (833987)
103 * Enabled with +inspect-jpegs in actions files.
105 * Revision 1.20.2.1 2002/09/25 14:51:51 oes
106 * Added basic support for OPTIONS and TRACE HTTP methods:
107 * New function direct_response which handles OPTIONS and
108 * TRACE requests whose Max-Forwards header field is zero.
110 * Revision 1.20 2002/04/02 14:56:16 oes
111 * Bugfix: is_untrusted_url() and trust_url() now depend on FEATURE_TRUST, not FEATURE_COOKIE_JAR
113 * Revision 1.19 2002/03/26 22:29:54 swa
114 * we have a new homepage!
116 * Revision 1.18 2002/03/25 22:12:45 oes
117 * Added fix for undefined INADDR_NONE on Solaris by Bart Schelstraete
119 * Revision 1.17 2002/03/24 13:25:43 swa
120 * name change related issues
122 * Revision 1.16 2002/01/17 21:01:02 jongfoster
123 * Moving all our URL and URL pattern parsing code to urlmatch.c.
125 * Revision 1.15 2001/10/10 16:44:16 oes
126 * Added match_portlist function
128 * Revision 1.14 2001/10/07 15:41:40 oes
129 * Added prototype for remove_chunked_transfer_coding
131 * Revision 1.13 2001/07/30 22:08:36 jongfoster
132 * Tidying up #defines:
133 * - All feature #defines are now of the form FEATURE_xxx
134 * - Permanently turned off WIN_GUI_EDIT
135 * - Permanently turned on WEBDAV and SPLIT_PROXY_ARGS
137 * Revision 1.12 2001/07/29 19:01:11 jongfoster
138 * Changed _FILENAME_H to FILENAME_H_INCLUDED.
139 * Added forward declarations for needed structures.
141 * Revision 1.11 2001/07/13 14:00:18 oes
142 * - Introduced gif_deanimate_response
143 * - Renamed re_process_buffer to pcrs_filter_response
144 * - Removed all #ifdef PCRS
146 * Revision 1.10 2001/06/29 13:29:01 oes
147 * Cleaned up and updated to reflect the changesin
150 * Revision 1.9 2001/06/07 23:10:53 jongfoster
151 * Replacing struct gateway with struct forward_spec
153 * Revision 1.8 2001/06/03 19:12:00 oes
154 * extracted-CGI relevant stuff
156 * Revision 1.7 2001/05/31 21:21:30 jongfoster
157 * Permissionsfile / actions file changes:
158 * - Changed "permission" to "action" throughout
159 * - changes to file format to allow string parameters
160 * - Moved helper functions to actions.c
162 * Revision 1.6 2001/05/29 09:50:24 jongfoster
163 * Unified blocklist/imagelist/permissionslist.
164 * File format is still under discussion, but the internal changes
167 * Also modified interceptor behaviour:
168 * - We now intercept all URLs beginning with one of the following
169 * prefixes (and *only* these prefixes):
171 * * http://ijbswa.sf.net/config/
172 * * http://ijbswa.sourceforge.net/config/
173 * - New interceptors "home page" - go to http://i.j.b/ to see it.
174 * - Internal changes so that intercepted and fast redirect pages
175 * are not replaced with an image.
176 * - Interceptors now have the option to send a binary page direct
177 * to the client. (i.e. ijb-send-banner uses this)
178 * - Implemented show-url-info interceptor. (Which is why I needed
179 * the above interceptors changes - a typical URL is
180 * "http://i.j.b/show-url-info?url=www.somesite.com/banner.gif".
181 * The previous mechanism would not have intercepted that, and
182 * if it had been intercepted then it then it would have replaced
185 * Revision 1.5 2001/05/27 22:17:04 oes
187 * - re_process_buffer no longer writes the modified buffer
188 * to the client, which was very ugly. It now returns the
189 * buffer, which it is then written by chat.
191 * - content_length now adjusts the Content-Length: header
192 * for modified documents rather than crunch()ing it.
193 * (Length info in csp->content_length, which is 0 for
194 * unmodified documents)
196 * - For this to work, sed() is called twice when filtering.
198 * Revision 1.4 2001/05/26 15:26:15 jongfoster
199 * ACL feature now provides more security by immediately dropping
200 * connections from untrusted hosts.
202 * Revision 1.3 2001/05/22 18:46:04 oes
204 * - Enabled filtering banners by size rather than URL
205 * by adding patterns that replace all standard banner
206 * sizes with the "Junkbuster" gif to the re_filterfile
208 * - Enabled filtering WebBugs by providing a pattern
209 * which kills all 1x1 images
211 * - Added support for PCRE_UNGREEDY behaviour to pcrs,
212 * which is selected by the (nonstandard and therefore
213 * capital) letter 'U' in the option string.
214 * It causes the quantifiers to be ungreedy by default.
215 * Appending a ? turns back to greedy (!).
217 * - Added a new interceptor ijb-send-banner, which
218 * sends back the "Junkbuster" gif. Without imagelist or
219 * MSIE detection support, or if tinygif = 1, or the
220 * URL isn't recognized as an imageurl, a lame HTML
221 * explanation is sent instead.
223 * - Added new feature, which permits blocking remote
224 * script redirects and firing back a local redirect
226 * The feature is conditionally compiled, i.e. it
227 * can be disabled with --disable-fast-redirects,
228 * plus it must be activated by a "fast-redirects"
229 * line in the config file, has its own log level
230 * and of course wants to be displayed by show-proxy-args
231 * Note: Boy, all the #ifdefs in 1001 locations and
232 * all the fumbling with configure.in and acconfig.h
233 * were *way* more work than the feature itself :-(
235 * - Because a generic redirect template was needed for
236 * this, tinygif = 3 now uses the same.
238 * - Moved GIFs, and other static HTTP response templates
243 * - Removed some >400 CRs again (Jon, you really worked
246 * Revision 1.2 2001/05/20 01:21:20 jongfoster
247 * Version 2.9.4 checkin.
248 * - Merged popupfile and cookiefile, and added control over PCRS
249 * filtering, in new "permissionsfile".
250 * - Implemented LOG_LEVEL_FATAL, so that if there is a configuration
251 * file error you now get a message box (in the Win32 GUI) rather
252 * than the program exiting with no explanation.
253 * - Made killpopup use the PCRS MIME-type checking and HTTP-header
255 * - Removed tabs from "config"
256 * - Moved duplicated url parsing code in "loaders.c" to a new funcition.
257 * - Bumped up version number.
259 * Revision 1.1.1.1 2001/05/15 13:58:52 oes
260 * Initial import of version 2.9.3 source tree
263 *********************************************************************/
273 struct access_control_addr;
276 struct http_response;
277 struct current_action_spec;
286 extern int block_acl(struct access_control_addr *dst, struct client_state *csp);
287 extern int acl_addr(const char *aspec, struct access_control_addr *aca);
288 #endif /* def FEATURE_ACL */
293 extern struct http_response *block_url(struct client_state *csp);
294 extern struct http_response *redirect_url(struct client_state *csp);
296 extern struct http_response *trust_url(struct client_state *csp);
297 #endif /* def FEATURE_TRUST */
303 extern int is_untrusted_url(const struct client_state *csp);
304 #endif /* def FEATURE_TRUST */
305 #ifdef FEATURE_IMAGE_BLOCKING
306 extern int is_imageurl(const struct client_state *csp);
307 #endif /* def FEATURE_IMAGE_BLOCKING */
308 extern int connect_port_is_forbidden(const struct client_state *csp);
311 * Determining applicable actions
313 extern void get_url_actions(struct client_state *csp,
314 struct http_request *http);
315 extern void apply_url_actions(struct current_action_spec *action,
316 struct http_request *http,
317 struct url_actions *b);
319 * Determining parent proxies
321 extern const struct forward_spec *forward_url(struct client_state *csp,
322 const struct http_request *http);
325 * Content modification
328 typedef char *(*filter_function_ptr)();
329 extern char *execute_content_filter(struct client_state *csp, filter_function_ptr content_filter);
331 extern filter_function_ptr get_filter_function(struct client_state *csp);
332 extern char *execute_single_pcrs_command(char *subject, const char *pcrs_command, int *hits);
333 extern char *rewrite_url(char *old_url, const char *pcrs_command);
334 extern char *get_last_url(char *subject, const char *redirect_mode);
336 extern pcrs_job *compile_dynamic_pcrs_job_list(const struct client_state *csp, const struct re_filterfile_spec *b);
338 extern inline int content_filters_enabled(const struct client_state *csp);
341 * Handling Max-Forwards:
343 extern struct http_response *direct_response(struct client_state *csp);
350 #define INADDR_NONE -1
354 * Revision control strings from this header and associated .c file
356 extern const char filters_rcs[];
357 extern const char filters_h_rcs[];
363 #endif /* ndef FILTERS_H_INCLUDED */