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