1 #ifndef FILTERS_H_INCLUDED
2 #define FILTERS_H_INCLUDED
3 #define FILTERS_H_VERSION "$Id: filters.h,v 1.27 2007/04/30 15:02:18 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.27 2007/04/30 15:02:18 fabiankeil
43 * Introduce dynamic pcrs jobs that can resolve variables.
45 * Revision 1.26 2007/03/13 11:28:43 fabiankeil
46 * - Fix port handling in acl_addr() and use a temporary acl spec
47 * copy so error messages don't contain a truncated version.
48 * - Log size of iob before and after decompression.
50 * Revision 1.25 2007/01/12 15:36:44 fabiankeil
51 * Mark *csp as immutable for is_untrusted_url()
52 * and is_imageurl(). Closes FR 1237736.
54 * Revision 1.24 2006/12/29 18:30:46 fabiankeil
55 * Fixed gcc43 conversion warnings,
56 * changed sprintf calls to snprintf.
58 * Revision 1.23 2006/11/28 15:19:43 fabiankeil
59 * Implemented +redirect{s@foo@bar@} to generate
60 * a redirect based on a rewritten version of the
63 * Revision 1.22 2006/07/18 14:48:46 david__schmidt
64 * Reorganizing the repository: swapping out what was HEAD (the old 3.1 branch)
65 * with what was really the latest development (the v_3_0_branch branch)
67 * Revision 1.20.2.2 2004/10/03 12:53:32 david__schmidt
68 * Add the ability to check jpeg images for invalid
69 * lengths of comment blocks. Defensive strategy
70 * against the exploit:
71 * Microsoft Security Bulletin MS04-028
72 * Buffer Overrun in JPEG Processing (GDI+) Could
73 * Allow Code Execution (833987)
74 * Enabled with +inspect-jpegs in actions files.
76 * Revision 1.20.2.1 2002/09/25 14:51:51 oes
77 * Added basic support for OPTIONS and TRACE HTTP methods:
78 * New function direct_response which handles OPTIONS and
79 * TRACE requests whose Max-Forwards header field is zero.
81 * Revision 1.20 2002/04/02 14:56:16 oes
82 * Bugfix: is_untrusted_url() and trust_url() now depend on FEATURE_TRUST, not FEATURE_COOKIE_JAR
84 * Revision 1.19 2002/03/26 22:29:54 swa
85 * we have a new homepage!
87 * Revision 1.18 2002/03/25 22:12:45 oes
88 * Added fix for undefined INADDR_NONE on Solaris by Bart Schelstraete
90 * Revision 1.17 2002/03/24 13:25:43 swa
91 * name change related issues
93 * Revision 1.16 2002/01/17 21:01:02 jongfoster
94 * Moving all our URL and URL pattern parsing code to urlmatch.c.
96 * Revision 1.15 2001/10/10 16:44:16 oes
97 * Added match_portlist function
99 * Revision 1.14 2001/10/07 15:41:40 oes
100 * Added prototype for remove_chunked_transfer_coding
102 * Revision 1.13 2001/07/30 22:08:36 jongfoster
103 * Tidying up #defines:
104 * - All feature #defines are now of the form FEATURE_xxx
105 * - Permanently turned off WIN_GUI_EDIT
106 * - Permanently turned on WEBDAV and SPLIT_PROXY_ARGS
108 * Revision 1.12 2001/07/29 19:01:11 jongfoster
109 * Changed _FILENAME_H to FILENAME_H_INCLUDED.
110 * Added forward declarations for needed structures.
112 * Revision 1.11 2001/07/13 14:00:18 oes
113 * - Introduced gif_deanimate_response
114 * - Renamed re_process_buffer to pcrs_filter_response
115 * - Removed all #ifdef PCRS
117 * Revision 1.10 2001/06/29 13:29:01 oes
118 * Cleaned up and updated to reflect the changesin
121 * Revision 1.9 2001/06/07 23:10:53 jongfoster
122 * Replacing struct gateway with struct forward_spec
124 * Revision 1.8 2001/06/03 19:12:00 oes
125 * extracted-CGI relevant stuff
127 * Revision 1.7 2001/05/31 21:21:30 jongfoster
128 * Permissionsfile / actions file changes:
129 * - Changed "permission" to "action" throughout
130 * - changes to file format to allow string parameters
131 * - Moved helper functions to actions.c
133 * Revision 1.6 2001/05/29 09:50:24 jongfoster
134 * Unified blocklist/imagelist/permissionslist.
135 * File format is still under discussion, but the internal changes
138 * Also modified interceptor behaviour:
139 * - We now intercept all URLs beginning with one of the following
140 * prefixes (and *only* these prefixes):
142 * * http://ijbswa.sf.net/config/
143 * * http://ijbswa.sourceforge.net/config/
144 * - New interceptors "home page" - go to http://i.j.b/ to see it.
145 * - Internal changes so that intercepted and fast redirect pages
146 * are not replaced with an image.
147 * - Interceptors now have the option to send a binary page direct
148 * to the client. (i.e. ijb-send-banner uses this)
149 * - Implemented show-url-info interceptor. (Which is why I needed
150 * the above interceptors changes - a typical URL is
151 * "http://i.j.b/show-url-info?url=www.somesite.com/banner.gif".
152 * The previous mechanism would not have intercepted that, and
153 * if it had been intercepted then it then it would have replaced
156 * Revision 1.5 2001/05/27 22:17:04 oes
158 * - re_process_buffer no longer writes the modified buffer
159 * to the client, which was very ugly. It now returns the
160 * buffer, which it is then written by chat.
162 * - content_length now adjusts the Content-Length: header
163 * for modified documents rather than crunch()ing it.
164 * (Length info in csp->content_length, which is 0 for
165 * unmodified documents)
167 * - For this to work, sed() is called twice when filtering.
169 * Revision 1.4 2001/05/26 15:26:15 jongfoster
170 * ACL feature now provides more security by immediately dropping
171 * connections from untrusted hosts.
173 * Revision 1.3 2001/05/22 18:46:04 oes
175 * - Enabled filtering banners by size rather than URL
176 * by adding patterns that replace all standard banner
177 * sizes with the "Junkbuster" gif to the re_filterfile
179 * - Enabled filtering WebBugs by providing a pattern
180 * which kills all 1x1 images
182 * - Added support for PCRE_UNGREEDY behaviour to pcrs,
183 * which is selected by the (nonstandard and therefore
184 * capital) letter 'U' in the option string.
185 * It causes the quantifiers to be ungreedy by default.
186 * Appending a ? turns back to greedy (!).
188 * - Added a new interceptor ijb-send-banner, which
189 * sends back the "Junkbuster" gif. Without imagelist or
190 * MSIE detection support, or if tinygif = 1, or the
191 * URL isn't recognized as an imageurl, a lame HTML
192 * explanation is sent instead.
194 * - Added new feature, which permits blocking remote
195 * script redirects and firing back a local redirect
197 * The feature is conditionally compiled, i.e. it
198 * can be disabled with --disable-fast-redirects,
199 * plus it must be activated by a "fast-redirects"
200 * line in the config file, has its own log level
201 * and of course wants to be displayed by show-proxy-args
202 * Note: Boy, all the #ifdefs in 1001 locations and
203 * all the fumbling with configure.in and acconfig.h
204 * were *way* more work than the feature itself :-(
206 * - Because a generic redirect template was needed for
207 * this, tinygif = 3 now uses the same.
209 * - Moved GIFs, and other static HTTP response templates
214 * - Removed some >400 CRs again (Jon, you really worked
217 * Revision 1.2 2001/05/20 01:21:20 jongfoster
218 * Version 2.9.4 checkin.
219 * - Merged popupfile and cookiefile, and added control over PCRS
220 * filtering, in new "permissionsfile".
221 * - Implemented LOG_LEVEL_FATAL, so that if there is a configuration
222 * file error you now get a message box (in the Win32 GUI) rather
223 * than the program exiting with no explanation.
224 * - Made killpopup use the PCRS MIME-type checking and HTTP-header
226 * - Removed tabs from "config"
227 * - Moved duplicated url parsing code in "loaders.c" to a new funcition.
228 * - Bumped up version number.
230 * Revision 1.1.1.1 2001/05/15 13:58:52 oes
231 * Initial import of version 2.9.3 source tree
234 *********************************************************************/
244 struct access_control_addr;
247 struct http_response;
248 struct current_action_spec;
257 extern int block_acl(struct access_control_addr *dst, struct client_state *csp);
258 extern int acl_addr(const char *aspec, struct access_control_addr *aca);
259 #endif /* def FEATURE_ACL */
264 extern struct http_response *block_url(struct client_state *csp);
265 extern struct http_response *redirect_url(struct client_state *csp);
267 extern struct http_response *trust_url(struct client_state *csp);
268 #endif /* def FEATURE_TRUST */
274 extern int is_untrusted_url(const struct client_state *csp);
275 #endif /* def FEATURE_TRUST */
276 #ifdef FEATURE_IMAGE_BLOCKING
277 extern int is_imageurl(const struct client_state *csp);
278 #endif /* def FEATURE_IMAGE_BLOCKING */
281 * Determining applicable actions
283 extern void url_actions(struct http_request *http,
284 struct client_state *csp);
285 extern void apply_url_actions(struct current_action_spec *action,
286 struct http_request *http,
287 struct url_actions *b);
289 * Determining parent proxies
291 extern const struct forward_spec *forward_url(struct http_request *http, struct client_state *csp);
294 * Content modification
296 extern char *pcrs_filter_response(struct client_state *csp);
297 extern char *gif_deanimate_response(struct client_state *csp);
298 extern char *jpeg_inspect_response(struct client_state *csp);
299 extern size_t remove_chunked_transfer_coding(char *buffer, const size_t size);
300 extern char *execute_single_pcrs_command(char *subject, const char *pcrs_command, int *hits);
301 extern char *rewrite_url(char *old_url, const char *pcrs_command);
302 extern char *get_last_url(char *subject, const char *redirect_mode);
304 extern pcrs_job *compile_dynamic_pcrs_job_list(const struct client_state *csp, const struct re_filterfile_spec *b);
307 * Handling Max-Forwards:
309 extern struct http_response *direct_response( struct client_state *csp);
316 #define INADDR_NONE -1
320 * Revision control strings from this header and associated .c file
322 extern const char filters_rcs[];
323 extern const char filters_h_rcs[];
329 #endif /* ndef FILTERS_H_INCLUDED */