Rebuild for 3.0.9 beta.
[privoxy.git] / filters.c
1 const char filters_rcs[] = "$Id: filters.c,v 1.107 2008/05/04 17:52:56 fabiankeil Exp $";
2 /*********************************************************************
3  *
4  * File        :  $Source: /cvsroot/ijbswa/current/filters.c,v $
5  *
6  * Purpose     :  Declares functions to parse/crunch headers and pages.
7  *                Functions declared include:
8  *                   `acl_addr', `add_stats', `block_acl', `block_imageurl',
9  *                   `block_url', `url_actions', `domain_split',
10  *                   `filter_popups', `forward_url', 'redirect_url',
11  *                   `ij_untrusted_url', `intercept_url', `pcrs_filter_respose',
12  *                   `ijb_send_banner', `trust_url', `gif_deanimate_response',
13  *                   `execute_single_pcrs_command', `rewrite_url',
14  *                   `get_last_url'
15  *
16  * Copyright   :  Written by and Copyright (C) 2001, 2004-2008 the SourceForge
17  *                Privoxy team. http://www.privoxy.org/
18  *
19  *                Based on the Internet Junkbuster originally written
20  *                by and Copyright (C) 1997 Anonymous Coders and
21  *                Junkbusters Corporation.  http://www.junkbusters.com
22  *
23  *                This program is free software; you can redistribute it
24  *                and/or modify it under the terms of the GNU General
25  *                Public License as published by the Free Software
26  *                Foundation; either version 2 of the License, or (at
27  *                your option) any later version.
28  *
29  *                This program is distributed in the hope that it will
30  *                be useful, but WITHOUT ANY WARRANTY; without even the
31  *                implied warranty of MERCHANTABILITY or FITNESS FOR A
32  *                PARTICULAR PURPOSE.  See the GNU General Public
33  *                License for more details.
34  *
35  *                The GNU General Public License should be included with
36  *                this file.  If not, you can view it at
37  *                http://www.gnu.org/copyleft/gpl.html
38  *                or write to the Free Software Foundation, Inc., 59
39  *                Temple Place - Suite 330, Boston, MA  02111-1307, USA.
40  *
41  * Revisions   :
42  *    $Log: filters.c,v $
43  *    Revision 1.107  2008/05/04 17:52:56  fabiankeil
44  *    Adjust parse_http_url() call to new prototype.
45  *
46  *    Revision 1.106  2008/05/03 16:40:44  fabiankeil
47  *    Change content_filters_enabled()'s parameter from
48  *    csp->action to action so it can be also used in the
49  *    CGI code. Don't bother checking if there are filters
50  *    loaded, as that's somewhat besides the point.
51  *
52  *    Revision 1.105  2008/03/28 15:13:39  fabiankeil
53  *    Remove inspect-jpegs action.
54  *
55  *    Revision 1.104  2008/03/27 18:27:24  fabiankeil
56  *    Remove kill-popups action.
57  *
58  *    Revision 1.103  2008/03/06 16:33:45  fabiankeil
59  *    If limit-connect isn't used, don't limit CONNECT requests to port 443.
60  *
61  *    Revision 1.102  2008/03/01 14:00:44  fabiankeil
62  *    Let the block action take the reason for the block
63  *    as argument and show it on the "blocked" page.
64  *
65  *    Revision 1.101  2008/02/23 16:57:12  fabiankeil
66  *    Rename url_actions() to get_url_actions() and let it
67  *    use the standard parameter ordering.
68  *
69  *    Revision 1.100  2008/02/23 16:33:43  fabiankeil
70  *    Let forward_url() use the standard parameter ordering
71  *    and mark its second parameter immutable.
72  *
73  *    Revision 1.99  2008/02/03 13:57:58  fabiankeil
74  *    Add SOCKS5 support for forward-override{}.
75  *
76  *    Revision 1.98  2008/01/04 17:43:45  fabiankeil
77  *    Improve the warning messages that get logged if the action files
78  *    "enable" filters but no filters of that type have been loaded.
79  *
80  *    Revision 1.97  2007/11/30 15:37:03  fabiankeil
81  *    Use freez instead of free.
82  *
83  *    Revision 1.96  2007/10/19 16:53:28  fabiankeil
84  *    Add helper function to check if any content filters are enabled.
85  *
86  *    Revision 1.95  2007/10/17 19:31:20  fabiankeil
87  *    Omitting the zero chunk that ends the chunk transfer encoding seems
88  *    to be the new black. Log the problem and continue filtering anyway.
89  *
90  *    Revision 1.94  2007/09/29 13:20:20  fabiankeil
91  *    Remove two redundant and one useless log messages.
92  *
93  *    Revision 1.93  2007/09/29 10:21:16  fabiankeil
94  *    - Move get_filter_function() from jcc.c to filters.c
95  *      so the filter functions can be static.
96  *    - Don't bother filtering body-less responses.
97  *
98  *    Revision 1.92  2007/09/28 16:38:55  fabiankeil
99  *    - Execute content filters through execute_content_filter().
100  *    - Add prepare_for_filtering() so filter functions don't have to
101  *      care about de-chunking and decompression. As a side effect this enables
102  *      decompression for gif_deanimate_response() and jpeg_inspect_response().
103  *    - Change remove_chunked_transfer_coding()'s return type to jb_err.
104  *      Some clowns feel like chunking empty responses in which case
105  *      (size == 0) is valid but previously would be interpreted as error.
106  *
107  *    Revision 1.91  2007/09/02 15:31:20  fabiankeil
108  *    Move match_portlist() from filter.c to urlmatch.c.
109  *    It's used for url matching, not for filtering.
110  *
111  *    Revision 1.90  2007/09/02 12:44:17  fabiankeil
112  *    Remove newline at the end of a log_error() message.
113  *
114  *    Revision 1.89  2007/08/05 13:42:23  fabiankeil
115  *    #1763173 from Stefan Huehner: declare some more functions static.
116  *
117  *    Revision 1.88  2007/06/01 16:41:11  fabiankeil
118  *    Add forward-override{} to change the forwarding settings through
119  *    action sections. This is mainly interesting to forward different
120  *    clients differently (for example based on User-Agent or request
121  *    origin).
122  *
123  *    Revision 1.87  2007/04/30 15:53:10  fabiankeil
124  *    Make sure filters with dynamic jobs actually use them.
125  *
126  *    Revision 1.86  2007/04/30 15:03:28  fabiankeil
127  *    - Introduce dynamic pcrs jobs that can resolve variables.
128  *    - Don't run redirect functions more than once,
129  *      unless they are activated more than once.
130  *
131  *    Revision 1.85  2007/03/21 12:24:47  fabiankeil
132  *    - Log the content size after decompression in decompress_iob()
133  *      instead of pcrs_filter_response().
134  *
135  *    Revision 1.84  2007/03/20 15:16:34  fabiankeil
136  *    Use dedicated header filter actions instead of abusing "filter".
137  *    Replace "filter-client-headers" and "filter-client-headers"
138  *    with "server-header-filter" and "client-header-filter".
139  *
140  *    Revision 1.83  2007/03/17 15:20:05  fabiankeil
141  *    New config option: enforce-blocks.
142  *
143  *    Revision 1.82  2007/03/13 11:28:43  fabiankeil
144  *    - Fix port handling in acl_addr() and use a temporary acl spec
145  *      copy so error messages don't contain a truncated version.
146  *    - Log size of iob before and after decompression.
147  *
148  *    Revision 1.81  2007/03/05 14:40:53  fabiankeil
149  *    - Cosmetical changes for LOG_LEVEL_RE_FILTER messages.
150  *    - Hide the "Go there anyway" link for blocked CONNECT
151  *      requests where going there anyway doesn't work anyway.
152  *
153  *    Revision 1.80  2007/02/07 10:55:20  fabiankeil
154  *    - Save the reason for generating http_responses.
155  *    - Block (+block) with status code 403 instead of 404.
156  *    - Use a different kludge to remember a failed decompression.
157  *
158  *    Revision 1.79  2007/01/31 16:21:38  fabiankeil
159  *    Search for Max-Forwards headers case-insensitive,
160  *    don't generate the "501 unsupported" message for invalid
161  *    Max-Forwards values and don't increase negative ones.
162  *
163  *    Revision 1.78  2007/01/28 13:41:18  fabiankeil
164  *    - Add HEAD support to finish_http_response.
165  *    - Add error favicon to internal HTML error messages.
166  *
167  *    Revision 1.77  2007/01/12 15:36:44  fabiankeil
168  *    Mark *csp as immutable for is_untrusted_url()
169  *    and is_imageurl(). Closes FR 1237736.
170  *
171  *    Revision 1.76  2007/01/01 19:36:37  fabiankeil
172  *    Integrate a modified version of Wil Mahan's
173  *    zlib patch (PR #895531).
174  *
175  *    Revision 1.75  2006/12/29 18:30:46  fabiankeil
176  *    Fixed gcc43 conversion warnings,
177  *    changed sprintf calls to snprintf.
178  *
179  *    Revision 1.74  2006/12/24 17:37:38  fabiankeil
180  *    Adjust comment in pcrs_filter_response()
181  *    to recent pcrs changes. Hohoho.
182  *
183  *    Revision 1.73  2006/12/23 16:01:02  fabiankeil
184  *    Don't crash if pcre returns an error code
185  *    that pcrs didn't expect. Fixes BR 1621173.
186  *
187  *    Revision 1.72  2006/12/22 18:52:53  fabiankeil
188  *    Modified is_untrusted_url to complain in case of
189  *    write errors and to give a reason when adding new
190  *    entries to the trustfile. Closes FR 1097611.
191  *
192  *    Revision 1.71  2006/12/22 14:24:52  fabiankeil
193  *    Skip empty filter files in pcrs_filter_response,
194  *    but don't ignore the ones that come afterwards.
195  *    Fixes parts of BR 1619208.
196  *
197  *    Revision 1.70  2006/12/09 13:33:15  fabiankeil
198  *    Added some sanity checks for get_last_url().
199  *    Fixed possible segfault caused by my last commit.
200  *
201  *    Revision 1.69  2006/12/08 12:39:13  fabiankeil
202  *    Let get_last_url() catch https URLs as well.
203  *
204  *    Revision 1.68  2006/12/05 14:45:48  fabiankeil
205  *    Make sure get_last_url() behaves like advertised
206  *    and fast-redirects{} can be combined with redirect{}.
207  *
208  *    Revision 1.67  2006/11/28 15:19:43  fabiankeil
209  *    Implemented +redirect{s@foo@bar@} to generate
210  *    a redirect based on a rewritten version of the
211  *    original URL.
212  *
213  *    Revision 1.66  2006/09/23 13:26:38  roro
214  *    Replace TABs by spaces in source code.
215  *
216  *    Revision 1.65  2006/09/21 12:54:43  fabiankeil
217  *    Fix +redirect{}. Didn't work with -fast-redirects.
218  *
219  *    Revision 1.64  2006/08/31 10:55:49  fabiankeil
220  *    Block requests for untrusted URLs with status
221  *    code 403 instead of 200.
222  *
223  *    Revision 1.63  2006/08/31 10:11:28  fabiankeil
224  *    Don't free p which is still in use and will be later
225  *    freed by free_map(). Don't claim the referrer is unknown
226  *    when the client didn't set one.
227  *
228  *    Revision 1.62  2006/08/14 00:27:47  david__schmidt
229  *    Feature request 595948: Re-Filter logging in single line
230  *
231  *    Revision 1.61  2006/08/03 02:46:41  david__schmidt
232  *    Incorporate Fabian Keil's patch work:\rhttp://www.fabiankeil.de/sourcecode/privoxy/
233  *
234  *    Revision 1.60  2006/07/18 14:48:46  david__schmidt
235  *    Reorganizing the repository: swapping out what was HEAD (the old 3.1 branch)
236  *    with what was really the latest development (the v_3_0_branch branch)
237  *
238  *    Revision 1.58.2.9  2006/01/29 23:10:56  david__schmidt
239  *    Multiple filter file support
240  *
241  *    Revision 1.58.2.8  2005/05/07 21:50:55  david__schmidt
242  *    A few memory leaks plugged (mostly on error paths)
243  *
244  *    Revision 1.58.2.7  2004/10/03 12:53:32  david__schmidt
245  *    Add the ability to check jpeg images for invalid
246  *    lengths of comment blocks.  Defensive strategy
247  *    against the exploit:
248  *       Microsoft Security Bulletin MS04-028
249  *       Buffer Overrun in JPEG Processing (GDI+) Could
250  *       Allow Code Execution (833987)
251  *    Enabled with +inspect-jpegs in actions files.
252  *
253  *    Revision 1.58.2.6  2003/12/06 22:18:27  gliptak
254  *    Correcting compile problem with FEATURE_IMAGE_BLOCKING
255  *
256  *    Revision 1.58.2.5  2003/11/11 13:10:31  oes
257  *    Fixed bug #839859: "See why" link URL now gets url-encoded.
258  *
259  *    Revision 1.58.2.4  2003/02/28 12:52:45  oes
260  *    Fixed a typo
261  *
262  *    Revision 1.58.2.3  2002/09/25 14:51:51  oes
263  *    Added basic support for OPTIONS and TRACE HTTP methods:
264  *    New function direct_response which handles OPTIONS and
265  *    TRACE requests whose Max-Forwards header field is zero.
266  *
267  *    Revision 1.58.2.2  2002/08/01 17:18:28  oes
268  *    Fixed BR 537651 / SR 579724 (MSIE image detect improper for IE/Mac)
269  *
270  *    Revision 1.58.2.1  2002/07/26 15:18:53  oes
271  *    - Bugfix: Executing a filters without jobs no longer results in
272  *      turing off *all* filters.
273  *    - Security fix: Malicious web servers can't cause a seg fault
274  *      through bogus chunk sizes anymore
275  *
276  *    Revision 1.58  2002/04/24 02:11:17  oes
277  *    Jon's multiple AF patch: url_actions now evaluates rules
278  *    from all AFs.
279  *
280  *    Revision 1.57  2002/04/08 20:38:34  swa
281  *    fixed JB spelling
282  *
283  *    Revision 1.56  2002/04/05 15:51:24  oes
284  *     - bugfix: error-pages now get correct request protocol
285  *     - fix for invalid HTML in trust info
286  *
287  *    Revision 1.55  2002/04/02 16:13:51  oes
288  *    Fix: No "Go there anyway" for SSL
289  *
290  *    Revision 1.54  2002/04/02 14:55:56  oes
291  *    Bugfix: is_untrusted_url() now depends on FEATURE_TRUST, not FEATURE_COOKIE_JAR
292  *
293  *    Revision 1.53  2002/03/26 22:29:54  swa
294  *    we have a new homepage!
295  *
296  *    Revision 1.52  2002/03/24 16:35:57  jongfoster
297  *    Removing logo
298  *
299  *    Revision 1.51  2002/03/24 15:23:33  jongfoster
300  *    Name changes
301  *
302  *    Revision 1.50  2002/03/24 13:25:43  swa
303  *    name change related issues
304  *
305  *    Revision 1.49  2002/03/16 20:29:14  oes
306  *    Cosmetics
307  *
308  *    Revision 1.48  2002/03/13 20:25:34  oes
309  *    Better logging for content filters
310  *
311  *    Revision 1.47  2002/03/13 00:30:52  jongfoster
312  *    Killing warnings
313  *    Added option of always sending redirect for imageblock,
314  *    currently disabled with #if 0.
315  *
316  *    Revision 1.46  2002/03/12 01:42:49  oes
317  *    Introduced modular filters
318  *
319  *    Revision 1.45  2002/03/08 16:47:50  oes
320  *    Added choice beween GIF and PNG built-in images
321  *
322  *    Revision 1.44  2002/03/07 03:49:31  oes
323  *     - Fixed compiler warnings etc
324  *     - Changed built-in images from GIF to PNG
325  *       (with regard to Unisys patent issue)
326  *     - Added a 4x4 pattern PNG which is less intrusive
327  *       than the logo but also clearly marks the deleted banners
328  *
329  *    Revision 1.43  2002/01/22 23:51:59  jongfoster
330  *    Replacing strsav() with the safer string_append().
331  *
332  *    Adding missing html_encode() to error message generators.  Where encoded
333  *    and unencoded versions of a string were provided, removing the unencoded
334  *    one.
335  *
336  *    Revision 1.42  2002/01/17 21:00:32  jongfoster
337  *    Moving all our URL and URL pattern parsing code to urlmatch.c.
338  *
339  *    Using a single, simple url_match(pattern,url) function - rather than
340  *    the 3-line match routine which was repeated all over the place.
341  *
342  *    Renaming free_url to free_url_spec, since it frees a struct url_spec.
343  *
344  *    Using parse_http_url() to parse URLs without faking a HTTP
345  *    request line for parse_http_request().
346  *
347  *    Revision 1.41  2001/11/13 00:14:07  jongfoster
348  *    Fixing stupid bug now I've figured out what || means.
349  *    (It always returns 0 or 1, not one of it's paramaters.)
350  *
351  *    Revision 1.40  2001/10/26 17:37:55  oes
352  *    - Re-enabled Netscape 200/404 bug workaround in block_url():
353  *      - Removed OS/2 special case
354  *      - Made block_url() independant from sed() having been run
355  *    - Made trust_url independant from sed() having been run
356  *    - Made is_imageurl independant from sed() having been run.
357  *      It now checks User-Agent: and Accept: by itself.
358  *
359  *
360  *    Revision 1.39  2001/10/25 03:40:48  david__schmidt
361  *    Change in porting tactics: OS/2's EMX porting layer doesn't allow multiple
362  *    threads to call select() simultaneously.  So, it's time to do a real, live,
363  *    native OS/2 port.  See defines for __EMX__ (the porting layer) vs. __OS2__
364  *    (native). Both versions will work, but using __OS2__ offers multi-threading.
365  *
366  *    Revision 1.38  2001/10/23 21:32:33  jongfoster
367  *    Adding error-checking to selected functions
368  *
369  *    Revision 1.37  2001/10/22 15:33:56  david__schmidt
370  *    Special-cased OS/2 out of the Netscape-abort-on-404-in-js problem in
371  *    filters.c.  Added a FIXME in front of the offending code.  I'll gladly
372  *    put in a better/more robust fix for all parties if one is presented...
373  *    It seems that just returning 200 instead of 404 would pretty much fix
374  *    it for everyone, but I don't know all the history of the problem.
375  *
376  *    Revision 1.36  2001/10/10 16:44:16  oes
377  *    Added match_portlist function
378  *
379  *    Revision 1.35  2001/10/07 15:41:23  oes
380  *    Replaced 6 boolean members of csp with one bitmap (csp->flags)
381  *
382  *    New function remove_chunked_transfer_coding that strips chunked
383  *      transfer coding to plain and is called by pcrs_filter_response
384  *      and gif_deanimate_response if neccessary
385  *
386  *    Improved handling of zero-change re_filter runs
387  *
388  *    pcrs_filter_response and gif_deanimate_response now remove
389  *      chunked transfer codeing before processing the body.
390  *
391  *    Revision 1.34  2001/09/20 15:49:36  steudten
392  *
393  *    Fix BUG: Change int size to size_t size in pcrs_filter_response().
394  *    See cgi.c fill_template().
395  *
396  *    Revision 1.33  2001/09/16 17:05:14  jongfoster
397  *    Removing unused #include showarg.h
398  *
399  *    Revision 1.32  2001/09/16 13:21:27  jongfoster
400  *    Changes to use new list functions.
401  *
402  *    Revision 1.31  2001/09/16 11:38:02  jongfoster
403  *    Splitting fill_template() into 2 functions:
404  *    template_load() loads the file
405  *    template_fill() performs the PCRS regexps.
406  *    This is because the CGI edit interface has a "table row"
407  *    template which is used many times in the page - this
408  *    change means it's only loaded from disk once.
409  *
410  *    Revision 1.30  2001/09/16 11:00:10  jongfoster
411  *    New function alloc_http_response, for symmetry with free_http_response
412  *
413  *    Revision 1.29  2001/09/13 23:32:40  jongfoster
414  *    Moving image data to cgi.c rather than cgi.h
415  *    Fixing a GPF under Win32 (and any other OS that protects global
416  *    constants from being written to).
417  *
418  *    Revision 1.28  2001/09/10 10:18:51  oes
419  *    Silenced compiler warnings
420  *
421  *    Revision 1.27  2001/08/05 16:06:20  jongfoster
422  *    Modifiying "struct map" so that there are now separate header and
423  *    "map_entry" structures.  This means that functions which modify a
424  *    map no longer need to return a pointer to the modified map.
425  *    Also, it no longer reverses the order of the entries (which may be
426  *    important with some advanced template substitutions).
427  *
428  *    Revision 1.26  2001/07/30 22:08:36  jongfoster
429  *    Tidying up #defines:
430  *    - All feature #defines are now of the form FEATURE_xxx
431  *    - Permanently turned off WIN_GUI_EDIT
432  *    - Permanently turned on WEBDAV and SPLIT_PROXY_ARGS
433  *
434  *    Revision 1.25  2001/07/26 10:09:46  oes
435  *    Made browser detection a little less naive
436  *
437  *    Revision 1.24  2001/07/25 17:22:51  oes
438  *    Added workaround for Netscape bug that prevents display of page when loading a component fails.
439  *
440  *    Revision 1.23  2001/07/23 13:40:12  oes
441  *    Fixed bug that caused document body to be dropped when pcrs joblist was empty.
442  *
443  *    Revision 1.22  2001/07/18 12:29:34  oes
444  *    - Made gif_deanimate_response respect
445  *      csp->action->string[ACTION_STRING_DEANIMATE]
446  *    - Logging cosmetics
447  *
448  *    Revision 1.21  2001/07/13 13:59:53  oes
449  *     - Introduced gif_deanimate_response which shares the
450  *       generic content modification interface of pcrs_filter_response
451  *       and acts as a wrapper to deanimate.c:gif_deanimate()
452  *     - Renamed re_process_buffer to pcrs_filter_response
453  *     - pcrs_filter_response now returns NULL on failiure
454  *     - Removed all #ifdef PCRS
455  *
456  *    Revision 1.20  2001/07/01 17:01:04  oes
457  *    Added comments and missing return statement in is_untrusted_url()
458  *
459  *    Revision 1.19  2001/06/29 21:45:41  oes
460  *    Indentation, CRLF->LF, Tab-> Space
461  *
462  *    Revision 1.18  2001/06/29 13:27:38  oes
463  *    - Cleaned up, renamed and reorderd functions
464  *      and improved comments
465  *
466  *    - block_url:
467  *      - Ported to CGI platform. Now delivers
468  *        http_response or NULL
469  *      - Unified HTML and GIF generation (moved image detection
470  *        and GIF generation here from jcc.c:chat())
471  *      - Fixed HTTP status to:
472  *       -  403 (Forbidden) for the "blocked" HTML message
473  *       -  200 (OK) for GIF answers
474  *       -  302 (Redirect) for redirect to GIF
475  *
476  *    - trust_url:
477  *      - Ported to CGI platform. Now delivers
478  *        http_response or NULL
479  *      - Separated detection of untrusted URL into
480  *        (bool)is_untrusted_url
481  *      - Added enforcement of untrusted requests
482  *
483  *    - Moved redirect_url() from cgi.c to here
484  *      and ported it to the CGI platform
485  *
486  *    - Removed logentry from cancelled commit
487  *
488  *    Revision 1.17  2001/06/09 10:55:28  jongfoster
489  *    Changing BUFSIZ ==> BUFFER_SIZE
490  *
491  *    Revision 1.16  2001/06/07 23:10:26  jongfoster
492  *    Allowing unanchored domain patterns to back off and retry
493  *    if they partially match.  Optimized right-anchored patterns.
494  *    Moving ACL and forward files into config file.
495  *    Replacing struct gateway with struct forward_spec
496  *
497  *    Revision 1.15  2001/06/03 19:12:00  oes
498  *    extracted-CGI relevant stuff
499  *
500  *    Revision 1.14  2001/06/01 10:30:55  oes
501  *    Added optional left-anchoring to domaincmp
502  *
503  *    Revision 1.13  2001/05/31 21:21:30  jongfoster
504  *    Permissionsfile / actions file changes:
505  *    - Changed "permission" to "action" throughout
506  *    - changes to file format to allow string parameters
507  *    - Moved helper functions to actions.c
508  *
509  *    Revision 1.12  2001/05/31 17:35:20  oes
510  *
511  *     - Enhanced domain part globbing with infix and prefix asterisk
512  *       matching and optional unanchored operation
513  *
514  *    Revision 1.11  2001/05/29 11:53:23  oes
515  *    "See why" link added to "blocked" page
516  *
517  *    Revision 1.10  2001/05/29 09:50:24  jongfoster
518  *    Unified blocklist/imagelist/permissionslist.
519  *    File format is still under discussion, but the internal changes
520  *    are (mostly) done.
521  *
522  *    Also modified interceptor behaviour:
523  *    - We now intercept all URLs beginning with one of the following
524  *      prefixes (and *only* these prefixes):
525  *        * http://i.j.b/
526  *        * http://ijbswa.sf.net/config/
527  *        * http://ijbswa.sourceforge.net/config/
528  *    - New interceptors "home page" - go to http://i.j.b/ to see it.
529  *    - Internal changes so that intercepted and fast redirect pages
530  *      are not replaced with an image.
531  *    - Interceptors now have the option to send a binary page direct
532  *      to the client. (i.e. ijb-send-banner uses this)
533  *    - Implemented show-url-info interceptor.  (Which is why I needed
534  *      the above interceptors changes - a typical URL is
535  *      "http://i.j.b/show-url-info?url=www.somesite.com/banner.gif".
536  *      The previous mechanism would not have intercepted that, and
537  *      if it had been intercepted then it then it would have replaced
538  *      it with an image.)
539  *
540  *    Revision 1.9  2001/05/27 22:17:04  oes
541  *
542  *    - re_process_buffer no longer writes the modified buffer
543  *      to the client, which was very ugly. It now returns the
544  *      buffer, which it is then written by chat.
545  *
546  *    - content_length now adjusts the Content-Length: header
547  *      for modified documents rather than crunch()ing it.
548  *      (Length info in csp->content_length, which is 0 for
549  *      unmodified documents)
550  *
551  *    - For this to work, sed() is called twice when filtering.
552  *
553  *    Revision 1.8  2001/05/26 17:13:28  jongfoster
554  *    Filled in a function comment.
555  *
556  *    Revision 1.7  2001/05/26 15:26:15  jongfoster
557  *    ACL feature now provides more security by immediately dropping
558  *    connections from untrusted hosts.
559  *
560  *    Revision 1.6  2001/05/26 00:28:36  jongfoster
561  *    Automatic reloading of config file.
562  *    Removed obsolete SIGHUP support (Unix) and Reload menu option (Win32).
563  *    Most of the global variables have been moved to a new
564  *    struct configuration_spec, accessed through csp->config->globalname
565  *    Most of the globals remaining are used by the Win32 GUI.
566  *
567  *    Revision 1.5  2001/05/25 22:34:30  jongfoster
568  *    Hard tabs->Spaces
569  *
570  *    Revision 1.4  2001/05/22 18:46:04  oes
571  *
572  *    - Enabled filtering banners by size rather than URL
573  *      by adding patterns that replace all standard banner
574  *      sizes with the "Junkbuster" gif to the re_filterfile
575  *
576  *    - Enabled filtering WebBugs by providing a pattern
577  *      which kills all 1x1 images
578  *
579  *    - Added support for PCRE_UNGREEDY behaviour to pcrs,
580  *      which is selected by the (nonstandard and therefore
581  *      capital) letter 'U' in the option string.
582  *      It causes the quantifiers to be ungreedy by default.
583  *      Appending a ? turns back to greedy (!).
584  *
585  *    - Added a new interceptor ijb-send-banner, which
586  *      sends back the "Junkbuster" gif. Without imagelist or
587  *      MSIE detection support, or if tinygif = 1, or the
588  *      URL isn't recognized as an imageurl, a lame HTML
589  *      explanation is sent instead.
590  *
591  *    - Added new feature, which permits blocking remote
592  *      script redirects and firing back a local redirect
593  *      to the browser.
594  *      The feature is conditionally compiled, i.e. it
595  *      can be disabled with --disable-fast-redirects,
596  *      plus it must be activated by a "fast-redirects"
597  *      line in the config file, has its own log level
598  *      and of course wants to be displayed by show-proxy-args
599  *      Note: Boy, all the #ifdefs in 1001 locations and
600  *      all the fumbling with configure.in and acconfig.h
601  *      were *way* more work than the feature itself :-(
602  *
603  *    - Because a generic redirect template was needed for
604  *      this, tinygif = 3 now uses the same.
605  *
606  *    - Moved GIFs, and other static HTTP response templates
607  *      to project.h
608  *
609  *    - Some minor fixes
610  *
611  *    - Removed some >400 CRs again (Jon, you really worked
612  *      a lot! ;-)
613  *
614  *    Revision 1.3  2001/05/20 16:44:47  jongfoster
615  *    Removing last hardcoded Junkbusters.com URLs.
616  *
617  *    Revision 1.2  2001/05/20 01:21:20  jongfoster
618  *    Version 2.9.4 checkin.
619  *    - Merged popupfile and cookiefile, and added control over PCRS
620  *      filtering, in new "permissionsfile".
621  *    - Implemented LOG_LEVEL_FATAL, so that if there is a configuration
622  *      file error you now get a message box (in the Win32 GUI) rather
623  *      than the program exiting with no explanation.
624  *    - Made killpopup use the PCRS MIME-type checking and HTTP-header
625  *      skipping.
626  *    - Removed tabs from "config"
627  *    - Moved duplicated url parsing code in "loaders.c" to a new funcition.
628  *    - Bumped up version number.
629  *
630  *    Revision 1.1.1.1  2001/05/15 13:58:52  oes
631  *    Initial import of version 2.9.3 source tree
632  *
633  *
634  *********************************************************************/
635 \f
636
637 #include "config.h"
638
639 #include <stdio.h>
640 #include <sys/types.h>
641 #include <stdlib.h>
642 #include <ctype.h>
643 #include <string.h>
644 #include <assert.h>
645
646 #ifndef _WIN32
647 #ifndef __OS2__
648 #include <unistd.h>
649 #endif /* ndef __OS2__ */
650 #include <netinet/in.h>
651 #else
652 #include <winsock2.h>
653 #endif /* ndef _WIN32 */
654
655 #ifdef __OS2__
656 #include <utils.h>
657 #endif /* def __OS2__ */
658
659 #include "project.h"
660 #include "filters.h"
661 #include "encode.h"
662 #include "parsers.h"
663 #include "ssplit.h"
664 #include "errlog.h"
665 #include "jbsockets.h"
666 #include "miscutil.h"
667 #include "actions.h"
668 #include "cgi.h"
669 #include "list.h"
670 #include "deanimate.h"
671 #include "urlmatch.h"
672 #include "loaders.h"
673
674 #ifdef _WIN32
675 #include "win32.h"
676 #endif
677
678 const char filters_h_rcs[] = FILTERS_H_VERSION;
679
680 /* Fix a problem with Solaris.  There should be no effect on other
681  * platforms.
682  * Solaris's isspace() is a macro which uses it's argument directly
683  * as an array index.  Therefore we need to make sure that high-bit
684  * characters generate +ve values, and ideally we also want to make
685  * the argument match the declared parameter type of "int".
686  */
687 #define ijb_isdigit(__X) isdigit((int)(unsigned char)(__X))
688
689 static jb_err remove_chunked_transfer_coding(char *buffer, size_t *size);
690 static jb_err prepare_for_filtering(struct client_state *csp);
691
692 #ifdef FEATURE_ACL
693 /*********************************************************************
694  *
695  * Function    :  block_acl
696  *
697  * Description :  Block this request?
698  *                Decide yes or no based on ACL file.
699  *
700  * Parameters  :
701  *          1  :  dst = The proxy or gateway address this is going to.
702  *                      Or NULL to check all possible targets.
703  *          2  :  csp = Current client state (buffers, headers, etc...)
704  *                      Also includes the client IP address.
705  *
706  * Returns     : 0 = FALSE (don't block) and 1 = TRUE (do block)
707  *
708  *********************************************************************/
709 int block_acl(const struct access_control_addr *dst, const struct client_state *csp)
710 {
711    struct access_control_list *acl = csp->config->acl;
712
713    /* if not using an access control list, then permit the connection */
714    if (acl == NULL)
715    {
716       return(0);
717    }
718
719    /* search the list */
720    while (acl != NULL)
721    {
722       if ((csp->ip_addr_long & acl->src->mask) == acl->src->addr)
723       {
724          if (dst == NULL)
725          {
726             /* Just want to check if they have any access */
727             if (acl->action == ACL_PERMIT)
728             {
729                return(0);
730             }
731          }
732          else if ( ((dst->addr & acl->dst->mask) == acl->dst->addr)
733            && ((dst->port == acl->dst->port) || (acl->dst->port == 0)))
734          {
735             if (acl->action == ACL_PERMIT)
736             {
737                return(0);
738             }
739             else
740             {
741                return(1);
742             }
743          }
744       }
745       acl = acl->next;
746    }
747
748    return(1);
749
750 }
751
752
753 /*********************************************************************
754  *
755  * Function    :  acl_addr
756  *
757  * Description :  Called from `load_config' to parse an ACL address.
758  *
759  * Parameters  :
760  *          1  :  aspec = String specifying ACL address.
761  *          2  :  aca = struct access_control_addr to fill in.
762  *
763  * Returns     :  0 => Ok, everything else is an error.
764  *
765  *********************************************************************/
766 int acl_addr(const char *aspec, struct access_control_addr *aca)
767 {
768    int i, masklength;
769    long port;
770    char *p;
771    char *acl_spec = NULL;
772
773    masklength = 32;
774    port       =  0;
775
776    /*
777     * Use a temporary acl spec copy so we can log
778     * the unmodified original in case of parse errors.
779     */
780    acl_spec = strdup(aspec);
781    if (acl_spec == NULL)
782    {
783       /* XXX: This will be logged as parse error. */
784       return(-1);
785    }
786
787    if ((p = strchr(acl_spec, '/')) != NULL)
788    {
789       *p++ = '\0';
790       if (ijb_isdigit(*p) == 0)
791       {
792          freez(acl_spec);
793          return(-1);
794       }
795       masklength = atoi(p);
796    }
797
798    if ((masklength < 0) || (masklength > 32))
799    {
800       freez(acl_spec);
801       return(-1);
802    }
803
804    if ((p = strchr(acl_spec, ':')) != NULL)
805    {
806       char *endptr;
807
808       *p++ = '\0';
809       port = strtol(p, &endptr, 10);
810
811       if (port <= 0 || port > 65535 || *endptr != '\0')
812       {
813          freez(acl_spec);
814          return(-1);
815       }
816    }
817
818    aca->port = (unsigned long)port;
819
820    aca->addr = ntohl(resolve_hostname_to_ip(acl_spec));
821    freez(acl_spec);
822
823    if (aca->addr == INADDR_NONE)
824    {
825       /* XXX: This will be logged as parse error. */
826       return(-1);
827    }
828
829    /* build the netmask */
830    aca->mask = 0;
831    for (i=1; i <= masklength ; i++)
832    {
833       aca->mask |= (1 << (32 - i));
834    }
835
836    /* now mask off the host portion of the ip address
837     * (i.e. save on the network portion of the address).
838     */
839    aca->addr = aca->addr & aca->mask;
840
841    return(0);
842
843 }
844 #endif /* def FEATURE_ACL */
845
846
847 /*********************************************************************
848  *
849  * Function    :  connect_port_is_forbidden
850  *
851  * Description :  Check to see if CONNECT requests to the destination
852  *                port of this request are forbidden. The check is
853  *                independend of the actual request method.
854  *
855  * Parameters  :
856  *          1  :  csp = Current client state (buffers, headers, etc...)
857  *
858  * Returns     :  True if yes, false otherwise.
859  *
860  *********************************************************************/
861 int connect_port_is_forbidden(const struct client_state *csp)
862 {
863    return ((csp->action->flags & ACTION_LIMIT_CONNECT) &&
864      !match_portlist(csp->action->string[ACTION_STRING_LIMIT_CONNECT],
865         csp->http->port));
866 }
867
868
869 /*********************************************************************
870  *
871  * Function    :  block_url
872  *
873  * Description :  Called from `chat'.  Check to see if we need to block this.
874  *
875  * Parameters  :
876  *          1  :  csp = Current client state (buffers, headers, etc...)
877  *
878  * Returns     :  NULL => unblocked, else HTTP block response
879  *
880  *********************************************************************/
881 struct http_response *block_url(struct client_state *csp)
882 {
883    struct http_response *rsp;
884    const char *new_content_type = NULL;
885
886    /*
887     * If it's not blocked, don't block it ;-)
888     */
889    if ((csp->action->flags & ACTION_BLOCK) == 0)
890    {
891       return NULL;
892    }
893    if (csp->action->flags & ACTION_REDIRECT)
894    {
895       log_error(LOG_LEVEL_ERROR, "redirect{} overruled by block.");     
896    }
897    /*
898     * Else, prepare a response
899     */
900    if (NULL == (rsp = alloc_http_response()))
901    {
902       return cgi_error_memory();
903    }
904
905    /*
906     * If it's an image-url, send back an image or redirect
907     * as specified by the relevant +image action
908     */
909 #ifdef FEATURE_IMAGE_BLOCKING
910    if (((csp->action->flags & ACTION_IMAGE_BLOCKER) != 0)
911         && is_imageurl(csp))
912    {
913       char *p;
914       /* determine HOW images should be blocked */
915       p = csp->action->string[ACTION_STRING_IMAGE_BLOCKER];
916
917       if(csp->action->flags & ACTION_HANDLE_AS_EMPTY_DOCUMENT)
918       {
919          log_error(LOG_LEVEL_ERROR, "handle-as-empty-document overruled by handle-as-image.");
920       }
921 #if 1 /* Two alternative strategies, use this one for now: */
922
923       /* and handle accordingly: */
924       if ((p == NULL) || (0 == strcmpic(p, "pattern")))
925       {
926          rsp->status = strdup("403 Request blocked by Privoxy");
927          if (rsp->status == NULL)
928          {
929             free_http_response(rsp);
930             return cgi_error_memory();
931          }
932          rsp->body = bindup(image_pattern_data, image_pattern_length);
933          if (rsp->body == NULL)
934          {
935             free_http_response(rsp);
936             return cgi_error_memory();
937          }
938          rsp->content_length = image_pattern_length;
939
940          if (enlist_unique_header(rsp->headers, "Content-Type", BUILTIN_IMAGE_MIMETYPE))
941          {
942             free_http_response(rsp);
943             return cgi_error_memory();
944          }
945       }
946
947       else if (0 == strcmpic(p, "blank"))
948       {
949          rsp->status = strdup("403 Request blocked by Privoxy");
950          if (rsp->status == NULL)
951          {
952             free_http_response(rsp);
953             return cgi_error_memory();
954          }
955          rsp->body = bindup(image_blank_data, image_blank_length);
956          if (rsp->body == NULL)
957          {
958             free_http_response(rsp);
959             return cgi_error_memory();
960          }
961          rsp->content_length = image_blank_length;
962
963          if (enlist_unique_header(rsp->headers, "Content-Type", BUILTIN_IMAGE_MIMETYPE))
964          {
965             free_http_response(rsp);
966             return cgi_error_memory();
967          }
968       }
969
970       else
971       {
972          rsp->status = strdup("302 Local Redirect from Privoxy");
973          if (rsp->status == NULL)
974          {
975             free_http_response(rsp);
976             return cgi_error_memory();
977          }
978
979          if (enlist_unique_header(rsp->headers, "Location", p))
980          {
981             free_http_response(rsp);
982             return cgi_error_memory();
983          }
984       }
985
986 #else /* Following code is disabled for now */
987
988       /* and handle accordingly: */
989       if ((p == NULL) || (0 == strcmpic(p, "pattern")))
990       {
991          p = CGI_PREFIX "send-banner?type=pattern";
992       }
993       else if (0 == strcmpic(p, "blank"))
994       {
995          p = CGI_PREFIX "send-banner?type=blank";
996       }
997       rsp->status = strdup("302 Local Redirect from Privoxy");
998       if (rsp->status == NULL)
999       {
1000          free_http_response(rsp);
1001          return cgi_error_memory();
1002       }
1003
1004       if (enlist_unique_header(rsp->headers, "Location", p))
1005       {
1006          free_http_response(rsp);
1007          return cgi_error_memory();
1008       }
1009 #endif /* Preceeding code is disabled for now */
1010    }
1011    else if(csp->action->flags & ACTION_HANDLE_AS_EMPTY_DOCUMENT)
1012    {
1013      /*
1014       *  Send empty document.               
1015       */
1016       new_content_type = csp->action->string[ACTION_STRING_CONTENT_TYPE];
1017
1018       freez(rsp->body);
1019       rsp->body = strdup(" ");
1020       rsp->content_length = 1;
1021
1022       rsp->status = strdup("403 Request blocked by Privoxy");
1023       if (rsp->status == NULL)
1024       {
1025          free_http_response(rsp);
1026          return cgi_error_memory();
1027       }
1028       if (new_content_type != 0)
1029       {
1030          log_error(LOG_LEVEL_HEADER, "Overwriting Content-Type with %s", new_content_type);
1031          if (enlist_unique_header(rsp->headers, "Content-Type", new_content_type))
1032          {
1033             free_http_response(rsp);
1034             return cgi_error_memory();
1035          }
1036       }
1037    }
1038    else
1039 #endif /* def FEATURE_IMAGE_BLOCKING */
1040
1041    /*
1042     * Else, generate an HTML "blocked" message:
1043     */
1044    {
1045       jb_err err;
1046       struct map * exports;
1047       char *p;
1048
1049       /*
1050        * Workaround for stupid Netscape bug which prevents
1051        * pages from being displayed if loading a referenced
1052        * JavaScript or style sheet fails. So make it appear
1053        * as if it succeeded.
1054        */
1055       if ( NULL != (p = get_header_value(csp->headers, "User-Agent:"))
1056            && !strncmpic(p, "mozilla", 7) /* Catch Netscape but */
1057            && !strstr(p, "Gecko")         /* save Mozilla, */
1058            && !strstr(p, "compatible")    /* MSIE */
1059            && !strstr(p, "Opera"))        /* and Opera. */
1060       {
1061          rsp->status = strdup("200 Request for blocked URL");
1062       }
1063       else
1064       {
1065          rsp->status = strdup("403 Request for blocked URL");
1066       }
1067
1068       if (rsp->status == NULL)
1069       {
1070          free_http_response(rsp);
1071          return cgi_error_memory();
1072       }
1073
1074       exports = default_exports(csp, NULL);
1075       if (exports == NULL)
1076       {
1077          free_http_response(rsp);
1078          return cgi_error_memory();
1079       }
1080
1081 #ifdef FEATURE_FORCE_LOAD
1082       err = map(exports, "force-prefix", 1, FORCE_PREFIX, 1);
1083       /*
1084        * Export the force conditional block killer if
1085        *
1086        * - Privoxy was compiled without FEATURE_FORCE_LOAD, or
1087        * - Privoxy is configured to enforce blocks, or
1088        * - it's a CONNECT request and enforcing wouldn't work anyway.
1089        */
1090       if ((csp->config->feature_flags & RUNTIME_FEATURE_ENFORCE_BLOCKS)
1091        || (0 == strcmpic(csp->http->gpc, "connect")))
1092 #endif /* ndef FEATURE_FORCE_LOAD */
1093       {
1094          err = map_block_killer(exports, "force-support");
1095       }
1096
1097       if (!err) err = map(exports, "protocol", 1, csp->http->ssl ? "https://" : "http://", 1);
1098       if (!err) err = map(exports, "hostport", 1, html_encode(csp->http->hostport), 0);
1099       if (!err) err = map(exports, "path", 1, html_encode(csp->http->path), 0);
1100       if (!err) err = map(exports, "path-ue", 1, url_encode(csp->http->path), 0);
1101       if (!err)
1102       {
1103          const char *block_reason;
1104          if (csp->action->string[ACTION_STRING_BLOCK] != NULL)
1105          {
1106             block_reason = csp->action->string[ACTION_STRING_BLOCK];
1107          }
1108          else
1109          {
1110             assert(connect_port_is_forbidden(csp));
1111             block_reason = "Forbidden CONNECT port.";
1112          }
1113          err = map(exports, "block-reason", 1, html_encode(block_reason), 0);
1114       }
1115       if (err)
1116       {
1117          free_map(exports);
1118          free_http_response(rsp);
1119          return cgi_error_memory();
1120       }
1121
1122       err = template_fill_for_cgi(csp, "blocked", exports, rsp);
1123       if (err)
1124       {
1125          free_http_response(rsp);
1126          return cgi_error_memory();
1127       }
1128    }
1129    rsp->reason = RSP_REASON_BLOCKED;
1130
1131    return finish_http_response(csp, rsp);
1132
1133 }
1134
1135
1136 #ifdef FEATURE_TRUST
1137 /*********************************************************************
1138  *
1139  * Function    :  trust_url FIXME: I should be called distrust_url
1140  *
1141  * Description :  Calls is_untrusted_url to determine if the URL is trusted
1142  *                and if not, returns a HTTP 403 response with a reject message.
1143  *
1144  * Parameters  :
1145  *          1  :  csp = Current client state (buffers, headers, etc...)
1146  *
1147  * Returns     :  NULL => trusted, else http_response.
1148  *
1149  *********************************************************************/
1150 struct http_response *trust_url(struct client_state *csp)
1151 {
1152    struct http_response *rsp;
1153    struct map * exports;
1154    char buf[BUFFER_SIZE];
1155    char *p;
1156    struct url_spec **tl;
1157    struct url_spec *t;
1158    jb_err err;
1159
1160    /*
1161     * Don't bother to work on trusted URLs
1162     */
1163    if (!is_untrusted_url(csp))
1164    {
1165       return NULL;
1166    }
1167
1168    /*
1169     * Else, prepare a response:
1170     */
1171    if (NULL == (rsp = alloc_http_response()))
1172    {
1173       return cgi_error_memory();
1174    }
1175
1176    rsp->status = strdup("403 Request blocked by Privoxy");
1177    exports = default_exports(csp, NULL);
1178    if (exports == NULL || rsp->status == NULL)
1179    {
1180       free_http_response(rsp);
1181       return cgi_error_memory();
1182    }
1183
1184    /*
1185     * Export the protocol, host, port, and referrer information
1186     */
1187    err = map(exports, "hostport", 1, csp->http->hostport, 1);
1188    if (!err) err = map(exports, "protocol", 1, csp->http->ssl ? "https://" : "http://", 1); 
1189    if (!err) err = map(exports, "path", 1, csp->http->path, 1);
1190
1191    if (NULL != (p = get_header_value(csp->headers, "Referer:")))
1192    {
1193       if (!err) err = map(exports, "referrer", 1, html_encode(p), 0);
1194    }
1195    else
1196    {
1197       if (!err) err = map(exports, "referrer", 1, "none set", 1);
1198    }
1199
1200    if (err)
1201    {
1202       free_map(exports);
1203       free_http_response(rsp);
1204       return cgi_error_memory();
1205    }
1206
1207    /*
1208     * Export the trust list
1209     */
1210    p = strdup("");
1211    for (tl = csp->config->trust_list; (t = *tl) != NULL ; tl++)
1212    {
1213       snprintf(buf, sizeof(buf), "<li>%s</li>\n", t->spec);
1214       string_append(&p, buf);
1215    }
1216    err = map(exports, "trusted-referrers", 1, p, 0);
1217
1218    if (err)
1219    {
1220       free_map(exports);
1221       free_http_response(rsp);
1222       return cgi_error_memory();
1223    }
1224
1225    /*
1226     * Export the trust info, if available
1227     */
1228    if (csp->config->trust_info->first)
1229    {
1230       struct list_entry *l;
1231
1232       p = strdup("");
1233       for (l = csp->config->trust_info->first; l ; l = l->next)
1234       {
1235          snprintf(buf, sizeof(buf), "<li> <a href=\"%s\">%s</a><br>\n", l->str, l->str);
1236          string_append(&p, buf);
1237       }
1238       err = map(exports, "trust-info", 1, p, 0);
1239    }
1240    else
1241    {
1242       err = map_block_killer(exports, "have-trust-info");
1243    }
1244
1245    if (err)
1246    {
1247       free_map(exports);
1248       free_http_response(rsp);
1249       return cgi_error_memory();
1250    }
1251
1252    /*
1253     * Export the force conditional block killer if
1254     *
1255     * - Privoxy was compiled without FEATURE_FORCE_LOAD, or
1256     * - Privoxy is configured to enforce blocks, or
1257     * - it's a CONNECT request and enforcing wouldn't work anyway.
1258     */
1259 #ifdef FEATURE_FORCE_LOAD
1260    if ((csp->config->feature_flags & RUNTIME_FEATURE_ENFORCE_BLOCKS)
1261     || (0 == strcmpic(csp->http->gpc, "connect")))
1262    {
1263       err = map_block_killer(exports, "force-support");
1264    }
1265    else
1266    {
1267       err = map(exports, "force-prefix", 1, FORCE_PREFIX, 1);
1268    }
1269 #else /* ifndef FEATURE_FORCE_LOAD */
1270    err = map_block_killer(exports, "force-support");
1271 #endif /* ndef FEATURE_FORCE_LOAD */
1272
1273    if (err)
1274    {
1275       free_map(exports);
1276       free_http_response(rsp);
1277       return cgi_error_memory();
1278    }
1279
1280    /*
1281     * Build the response
1282     */
1283    err = template_fill_for_cgi(csp, "untrusted", exports, rsp);
1284    if (err)
1285    {
1286       free_http_response(rsp);
1287       return cgi_error_memory();
1288    }
1289    rsp->reason = RSP_REASON_UNTRUSTED;
1290
1291    return finish_http_response(csp, rsp);
1292 }
1293 #endif /* def FEATURE_TRUST */
1294
1295
1296 /*********************************************************************
1297  *
1298  * Function    :  compile_dynamic_pcrs_job_list
1299  *
1300  * Description :  Compiles a dynamic pcrs job list (one with variables
1301  *                resolved at request time)
1302  *
1303  * Parameters  :
1304  *          1  :  csp = Current client state (buffers, headers, etc...)
1305  *          2  :  b = The filter list to compile
1306  *
1307  * Returns     :  NULL in case of errors, otherwise the
1308  *                pcrs job list.  
1309  *
1310  *********************************************************************/
1311 pcrs_job *compile_dynamic_pcrs_job_list(const struct client_state *csp, const struct re_filterfile_spec *b)
1312 {
1313    struct list_entry *pattern;
1314    pcrs_job *job_list = NULL;
1315    pcrs_job *dummy = NULL;
1316    pcrs_job *lastjob = NULL;
1317    int error = 0;
1318
1319    const struct pcrs_variable variables[] =
1320    {
1321       {"url",    csp->http->url,   1},
1322       {"path",   csp->http->path,  1},
1323       {"host",   csp->http->host,  1},
1324       {"origin", csp->ip_addr_str, 1},
1325       {NULL,     NULL,             1}
1326    };
1327
1328    for (pattern = b->patterns->first; pattern != NULL; pattern = pattern->next)
1329    {
1330       assert(pattern->str != NULL);
1331
1332       dummy = pcrs_compile_dynamic_command(pattern->str, variables, &error);
1333       if (NULL == dummy)
1334       {
1335          assert(error < 0);
1336          log_error(LOG_LEVEL_ERROR,
1337             "Adding filter job \'%s\' to dynamic filter %s failed: %s",
1338             pattern->str, b->name, pcrs_strerror(error));
1339          continue;
1340       }
1341       else
1342       {
1343          if (error == PCRS_WARN_TRUNCATION)
1344          {
1345             log_error(LOG_LEVEL_ERROR,
1346                "At least one of the variables in \'%s\' had to "
1347                "be truncated before compilation", pattern->str);
1348          }
1349          if (job_list == NULL)
1350          {
1351             job_list = dummy;
1352          }
1353          else
1354          {
1355             lastjob->next = dummy;
1356          }
1357          lastjob = dummy;
1358       }
1359    }
1360
1361    return job_list;
1362 }
1363
1364
1365 /*********************************************************************
1366  *
1367  * Function    :  rewrite_url
1368  *
1369  * Description :  Rewrites a URL with a single pcrs command
1370  *                and returns the result if it differs from the
1371  *                original and isn't obviously invalid.
1372  *
1373  * Parameters  :
1374  *          1  :  old_url = URL to rewrite.
1375  *          2  :  pcrs_command = pcrs command formatted as string (s@foo@bar@)
1376  *
1377  *
1378  * Returns     :  NULL if the pcrs_command didn't change the url, or 
1379  *                the result of the modification.
1380  *
1381  *********************************************************************/
1382 char *rewrite_url(char *old_url, const char *pcrs_command)
1383 {
1384    char *new_url = NULL;
1385    int hits;
1386
1387    assert(old_url);
1388    assert(pcrs_command);
1389
1390    new_url = pcrs_execute_single_command(old_url, pcrs_command, &hits);
1391
1392    if (hits == 0)
1393    {
1394       log_error(LOG_LEVEL_REDIRECTS,
1395          "pcrs command \"%s\" didn't change \"%s\".",
1396          pcrs_command, old_url);
1397       freez(new_url);
1398    }
1399    else if (hits < 0)
1400    {
1401       log_error(LOG_LEVEL_REDIRECTS,
1402          "executing pcrs command \"%s\" to rewrite %s failed: %s",
1403          pcrs_command, old_url, pcrs_strerror(hits));
1404       freez(new_url);
1405    }
1406    else if (strncmpic(new_url, "http://", 7) && strncmpic(new_url, "https://", 8))
1407    {
1408       log_error(LOG_LEVEL_ERROR,
1409          "pcrs command \"%s\" changed \"%s\" to \"%s\" (%u hi%s), "
1410          "but the result doesn't look like a valid URL and will be ignored.",
1411          pcrs_command, old_url, new_url, hits, (hits == 1) ? "t" : "ts");
1412       freez(new_url);
1413    }
1414    else
1415    {
1416       log_error(LOG_LEVEL_REDIRECTS,
1417          "pcrs command \"%s\" changed \"%s\" to \"%s\" (%u hi%s).",
1418          pcrs_command, old_url, new_url, hits, (hits == 1) ? "t" : "ts");
1419    }
1420
1421    return new_url;
1422
1423 }
1424
1425
1426 #ifdef FEATURE_FAST_REDIRECTS
1427 /*********************************************************************
1428  *
1429  * Function    :  get_last_url
1430  *
1431  * Description :  Search for the last URL inside a string.
1432  *                If the string already is a URL, it will
1433  *                be the first URL found.
1434  *
1435  * Parameters  :
1436  *          1  :  subject = the string to check
1437  *          2  :  redirect_mode = +fast-redirect{} mode 
1438  *
1439  * Returns     :  NULL if no URL was found, or
1440  *                the last URL found.
1441  *
1442  *********************************************************************/
1443 char *get_last_url(char *subject, const char *redirect_mode)
1444 {
1445    char *new_url = NULL;
1446    char *tmp;
1447
1448    assert(subject);
1449    assert(redirect_mode);
1450
1451    subject = strdup(subject);
1452    if (subject == NULL)
1453    {
1454       log_error(LOG_LEVEL_ERROR, "Out of memory while searching for redirects.");
1455       return NULL;
1456    }
1457
1458    if (0 == strcmpic(redirect_mode, "check-decoded-url"))
1459    {  
1460       log_error(LOG_LEVEL_REDIRECTS, "Decoding \"%s\" if necessary.", subject);
1461       new_url = url_decode(subject);
1462       if (new_url != NULL)
1463       {
1464          freez(subject);
1465          subject = new_url;
1466       }
1467       else
1468       {
1469          log_error(LOG_LEVEL_ERROR, "Unable to decode \"%s\".", subject);
1470       }
1471    }
1472
1473    log_error(LOG_LEVEL_REDIRECTS, "Checking \"%s\" for redirects.", subject);
1474
1475    /*
1476     * Find the last URL encoded in the request
1477     */
1478    tmp = subject;
1479    while ((tmp = strstr(tmp, "http://")) != NULL)
1480    {
1481       new_url = tmp++;
1482    }
1483    tmp = (new_url != NULL) ? new_url : subject;
1484    while ((tmp = strstr(tmp, "https://")) != NULL)
1485    {
1486       new_url = tmp++;
1487    }
1488
1489    if ((new_url != NULL)
1490       && (  (new_url != subject)
1491          || (0 == strncmpic(subject, "http://", 7))
1492          || (0 == strncmpic(subject, "https://", 8))
1493          ))
1494    {
1495       /*
1496        * Return new URL if we found a redirect 
1497        * or if the subject already was a URL.
1498        *
1499        * The second case makes sure that we can
1500        * chain get_last_url after another redirection check
1501        * (like rewrite_url) without losing earlier redirects.
1502        */
1503       new_url = strdup(new_url);
1504       freez(subject);
1505       return new_url;
1506    }
1507
1508    freez(subject);
1509    return NULL;
1510
1511 }
1512 #endif /* def FEATURE_FAST_REDIRECTS */
1513
1514
1515 /*********************************************************************
1516  *
1517  * Function    :  redirect_url
1518  *
1519  * Description :  Checks if Privoxy should answer the request with
1520  *                a HTTP redirect and generates the redirect if
1521  *                necessary.
1522  *
1523  * Parameters  :
1524  *          1  :  csp = Current client state (buffers, headers, etc...)
1525  *
1526  * Returns     :  NULL if the request can pass, HTTP redirect otherwise.
1527  *
1528  *********************************************************************/
1529 struct http_response *redirect_url(struct client_state *csp)
1530 {
1531    struct http_response *rsp;
1532 #ifdef FEATURE_FAST_REDIRECTS
1533    /*
1534     * XXX: Do we still need FEATURE_FAST_REDIRECTS
1535     * as compile-time option? The user can easily disable
1536     * it in his action file.
1537     */
1538    char * redirect_mode;
1539 #endif /* def FEATURE_FAST_REDIRECTS */
1540    char *old_url = NULL;
1541    char *new_url = NULL;
1542    char *redirection_string;
1543
1544    if ((csp->action->flags & ACTION_REDIRECT))
1545    {
1546       redirection_string = csp->action->string[ACTION_STRING_REDIRECT];
1547
1548       /*
1549        * If the redirection string begins with 's',
1550        * assume it's a pcrs command, otherwise treat it as
1551        * properly formatted URL and use it for the redirection
1552        * directly.
1553        *
1554        * According to RFC 2616 section 14.30 the URL
1555        * has to be absolute and if the user tries:
1556        * +redirect{shit/this/will/be/parsed/as/pcrs_command.html}
1557        * she would get undefined results anyway.
1558        *
1559        */
1560
1561       if (*redirection_string == 's')
1562       {
1563          old_url = csp->http->url;
1564          new_url = rewrite_url(old_url, redirection_string);
1565       }
1566       else
1567       {
1568          log_error(LOG_LEVEL_REDIRECTS,
1569             "No pcrs command recognized, assuming that \"%s\" is already properly formatted.",
1570             redirection_string);
1571          new_url = strdup(redirection_string);
1572       }
1573    }
1574
1575 #ifdef FEATURE_FAST_REDIRECTS
1576    if ((csp->action->flags & ACTION_FAST_REDIRECTS))
1577    {
1578       redirect_mode = csp->action->string[ACTION_STRING_FAST_REDIRECTS];
1579
1580       /*
1581        * If it exists, use the previously rewritten URL as input
1582        * otherwise just use the old path.
1583        */
1584       old_url = (new_url != NULL) ? new_url : strdup(csp->http->path);
1585       new_url = get_last_url(old_url, redirect_mode);
1586       freez(old_url);
1587    }
1588
1589    /*
1590     * Disable redirect checkers, so that they
1591     * will be only run more than once if the user
1592     * also enables them through tags.
1593     *
1594     * From a performance point of view
1595     * it doesn't matter, but the duplicated
1596     * log messages are annoying.
1597     */
1598    csp->action->flags &= ~ACTION_FAST_REDIRECTS;
1599 #endif /* def FEATURE_FAST_REDIRECTS */
1600    csp->action->flags &= ~ACTION_REDIRECT;
1601
1602    /* Did any redirect action trigger? */   
1603    if (new_url)
1604    {
1605       if (0 == strcmpic(new_url, csp->http->url))
1606       {
1607          log_error(LOG_LEVEL_ERROR,
1608             "New URL \"%s\" and old URL \"%s\" are the same. Redirection loop prevented.",
1609             csp->http->url, new_url);
1610             freez(new_url);
1611       }
1612       else
1613       {
1614          log_error(LOG_LEVEL_REDIRECTS, "New URL is: %s", new_url);
1615
1616          if (NULL == (rsp = alloc_http_response()))
1617          {
1618             freez(new_url);
1619             return cgi_error_memory();
1620          }
1621
1622          if ( enlist_unique_header(rsp->headers, "Location", new_url)
1623            || (NULL == (rsp->status = strdup("302 Local Redirect from Privoxy"))) )
1624          {
1625             freez(new_url);
1626             free_http_response(rsp);
1627             return cgi_error_memory();
1628          }
1629          rsp->reason = RSP_REASON_REDIRECTED;
1630          freez(new_url);
1631
1632          return finish_http_response(csp, rsp);
1633       }
1634    }
1635
1636    /* Only reached if no redirect is required */
1637    return NULL;
1638
1639 }
1640
1641
1642 #ifdef FEATURE_IMAGE_BLOCKING
1643 /*********************************************************************
1644  *
1645  * Function    :  is_imageurl
1646  *
1647  * Description :  Given a URL, decide whether it is an image or not,
1648  *                using either the info from a previous +image action
1649  *                or, #ifdef FEATURE_IMAGE_DETECT_MSIE, and the browser
1650  *                is MSIE and not on a Mac, tell from the browser's accept
1651  *                header.
1652  *
1653  * Parameters  :
1654  *          1  :  csp = Current client state (buffers, headers, etc...)
1655  *
1656  * Returns     :  True (nonzero) if URL is an image, false (0)
1657  *                otherwise
1658  *
1659  *********************************************************************/
1660 int is_imageurl(const struct client_state *csp)
1661 {
1662 #ifdef FEATURE_IMAGE_DETECT_MSIE
1663    char *tmp;
1664
1665    tmp = get_header_value(csp->headers, "User-Agent:");
1666    if (tmp && strstr(tmp, "MSIE") && !strstr(tmp, "Mac_"))
1667    {
1668       tmp = get_header_value(csp->headers, "Accept:");
1669       if (tmp && strstr(tmp, "image/gif"))
1670       {
1671          /* Client will accept HTML.  If this seems counterintuitive,
1672           * blame Microsoft.
1673           */
1674          return(0);
1675       }
1676       else
1677       {
1678          return(1);
1679       }
1680    }
1681 #endif /* def FEATURE_IMAGE_DETECT_MSIE */
1682
1683    return ((csp->action->flags & ACTION_IMAGE) != 0);
1684
1685 }
1686 #endif /* def FEATURE_IMAGE_BLOCKING */
1687
1688
1689 #ifdef FEATURE_TRUST
1690 /*********************************************************************
1691  *
1692  * Function    :  is_untrusted_url
1693  *
1694  * Description :  Should we "distrust" this URL (and block it)?
1695  *
1696  *                Yes if it matches a line in the trustfile, or if the
1697  *                    referrer matches a line starting with "+" in the
1698  *                    trustfile.
1699  *                No  otherwise.
1700  *
1701  * Parameters  :
1702  *          1  :  csp = Current client state (buffers, headers, etc...)
1703  *
1704  * Returns     :  0 => trusted, 1 => untrusted
1705  *
1706  *********************************************************************/
1707 int is_untrusted_url(const struct client_state *csp)
1708 {
1709    struct file_list *fl;
1710    struct block_spec *b;
1711    struct url_spec **trusted_url;
1712    struct http_request rhttp[1];
1713    const char * referer;
1714    jb_err err;
1715
1716    /*
1717     * If we don't have a trustlist, we trust everybody
1718     */
1719    if (((fl = csp->tlist) == NULL) || ((b  = fl->f) == NULL))
1720    {
1721       return 0;
1722    }
1723
1724    memset(rhttp, '\0', sizeof(*rhttp));
1725
1726    /*
1727     * Do we trust the request URL itself?
1728     */
1729    for (b = b->next; b ; b = b->next)
1730    {
1731       if (url_match(b->url, csp->http))
1732       {
1733          return b->reject;
1734       }
1735    }
1736
1737    if (NULL == (referer = get_header_value(csp->headers, "Referer:")))
1738    {
1739       /* no referrer was supplied */
1740       return 1;
1741    }
1742
1743
1744    /*
1745     * If not, do we maybe trust its referrer?
1746     */
1747    err = parse_http_url(referer, rhttp, REQUIRE_PROTOCOL);
1748    if (err)
1749    {
1750       return 1;
1751    }
1752
1753    for (trusted_url = csp->config->trust_list; *trusted_url != NULL; trusted_url++)
1754    {
1755       if (url_match(*trusted_url, rhttp))
1756       {
1757          /* if the URL's referrer is from a trusted referrer, then
1758           * add the target spec to the trustfile as an unblocked
1759           * domain and return 0 (which means it's OK).
1760           */
1761
1762          FILE *fp;
1763
1764          if (NULL != (fp = fopen(csp->config->trustfile, "a")))
1765          {
1766             char * path;
1767             char * path_end;
1768             char * new_entry = strdup("~");
1769
1770             string_append(&new_entry, csp->http->hostport);
1771
1772             path = csp->http->path;
1773             if ( (path[0] == '/')
1774               && (path[1] == '~')
1775               && ((path_end = strchr(path + 2, '/')) != NULL))
1776             {
1777                /* since this path points into a user's home space
1778                 * be sure to include this spec in the trustfile.
1779                 */
1780                int path_len = path_end - path; /* save offset */
1781                path = strdup(path); /* Copy string */
1782                if (path != NULL)
1783                {
1784                   path_end = path + path_len; /* regenerate ptr to new buffer */
1785                   *(path_end + 1) = '\0'; /* Truncate path after '/' */
1786                }
1787                string_join(&new_entry, path);
1788             }
1789
1790             /*
1791              * Give a reason for generating this entry.
1792              */
1793             string_append(&new_entry, " # Trusted referrer was: ");
1794             string_append(&new_entry, referer);
1795
1796             if (new_entry != NULL)
1797             {
1798                if (-1 == fprintf(fp, "%s\n", new_entry))
1799                {
1800                   log_error(LOG_LEVEL_ERROR, "Failed to append \'%s\' to trustfile \'%s\': %E",
1801                      new_entry, csp->config->trustfile);
1802                }
1803                freez(new_entry);
1804             }
1805             else
1806             {
1807                /* FIXME: No way to handle out-of memory, so mostly ignoring it */
1808                log_error(LOG_LEVEL_ERROR, "Out of memory adding pattern to trust file");
1809             }
1810
1811             fclose(fp);
1812          }
1813          else
1814          {
1815             log_error(LOG_LEVEL_ERROR, "Failed to append new entry for \'%s\' to trustfile \'%s\': %E",
1816                csp->http->hostport, csp->config->trustfile);
1817          }
1818          return 0;
1819       }
1820    }
1821
1822    return 1;
1823 }
1824 #endif /* def FEATURE_TRUST */
1825
1826
1827 /*********************************************************************
1828  *
1829  * Function    :  pcrs_filter_response
1830  *
1831  * Description :  Execute all text substitutions from all applying
1832  *                +filter actions on the text buffer that's been
1833  *                accumulated in csp->iob->buf.
1834  *
1835  * Parameters  :
1836  *          1  :  csp = Current client state (buffers, headers, etc...)
1837  *
1838  * Returns     :  a pointer to the (newly allocated) modified buffer.
1839  *                or NULL if there were no hits or something went wrong
1840  *
1841  *********************************************************************/
1842 static char *pcrs_filter_response(struct client_state *csp)
1843 {
1844    int hits=0;
1845    size_t size, prev_size;
1846
1847    char *old = NULL;
1848    char *new = NULL;
1849    pcrs_job *job;
1850
1851    struct file_list *fl;
1852    struct re_filterfile_spec *b;
1853    struct list_entry *filtername;
1854
1855    int i, found_filters = 0;
1856
1857    /* 
1858     * Sanity first
1859     */
1860    if (csp->iob->cur >= csp->iob->eod)
1861    {
1862       return(NULL);
1863    }
1864
1865    /*
1866     * Need to check the set of re_filterfiles...
1867     */
1868    for (i = 0; i < MAX_AF_FILES; i++)
1869    {
1870       fl = csp->rlist[i];
1871       if (NULL != fl)
1872       {
1873          if (NULL != fl->f)
1874          {
1875            found_filters = 1;
1876            break;
1877          }
1878       }
1879    }
1880
1881    if (0 == found_filters)
1882    {
1883       log_error(LOG_LEVEL_ERROR, "Inconsistent configuration: "
1884          "content filtering enabled, but no content filters available.");
1885       return(NULL);
1886    }
1887
1888    size = (size_t)(csp->iob->eod - csp->iob->cur);
1889    old = csp->iob->cur;
1890
1891    for (i = 0; i < MAX_AF_FILES; i++)
1892    {
1893      fl = csp->rlist[i];
1894      if ((NULL == fl) || (NULL == fl->f))
1895      {
1896         /*
1897          * Either there are no filter files
1898          * left, or this filter file just
1899          * contains no valid filters.
1900          *
1901          * Continue to be sure we don't miss
1902          * valid filter files that are chained
1903          * after empty or invalid ones.
1904          */
1905         continue;
1906      }
1907    /*
1908     * For all applying +filter actions, look if a filter by that
1909     * name exists and if yes, execute it's pcrs_joblist on the
1910     * buffer.
1911     */
1912    for (b = fl->f; b; b = b->next)
1913    {
1914       if (b->type != FT_CONTENT_FILTER)
1915       {
1916          /* Skip header filters */
1917          continue;
1918       }
1919
1920       for (filtername = csp->action->multi[ACTION_MULTI_FILTER]->first;
1921            filtername ; filtername = filtername->next)
1922       {
1923          if (strcmp(b->name, filtername->str) == 0)
1924          {
1925             int current_hits = 0; /* Number of hits caused by this filter */
1926             int job_number   = 0; /* Which job we're currently executing  */
1927             int job_hits     = 0; /* How many hits the current job caused */
1928             pcrs_job *joblist = b->joblist;
1929
1930             if (b->dynamic) joblist = compile_dynamic_pcrs_job_list(csp, b);
1931
1932             if (NULL == joblist)
1933             {
1934                log_error(LOG_LEVEL_RE_FILTER, "Filter %s has empty joblist. Nothing to do.", b->name);
1935                continue;
1936             }
1937
1938             prev_size = size;
1939             /* Apply all jobs from the joblist */
1940             for (job = joblist; NULL != job; job = job->next)
1941             {
1942                job_number++;
1943                job_hits = pcrs_execute(job, old, size, &new, &size);
1944
1945                if (job_hits >= 0)
1946                {
1947                   /*
1948                    * That went well. Continue filtering
1949                    * and use the result of this job as
1950                    * input for the next one.
1951                    */
1952                   current_hits += job_hits;
1953                   if (old != csp->iob->cur)
1954                   {
1955                      freez(old);
1956                   }
1957                   old = new;
1958                }
1959                else
1960                {
1961                   /*
1962                    * This job caused an unexpected error. Inform the user
1963                    * and skip the rest of the jobs in this filter. We could
1964                    * continue with the next job, but usually the jobs
1965                    * depend on each other or are similar enough to
1966                    * fail for the same reason.
1967                    *
1968                    * At the moment our pcrs expects the error codes of pcre 3.4,
1969                    * but newer pcre versions can return additional error codes.
1970                    * As a result pcrs_strerror()'s error message might be
1971                    * "Unknown error ...", therefore we print the numerical value
1972                    * as well.
1973                    *
1974                    * XXX: Is this important enough for LOG_LEVEL_ERROR or
1975                    * should we use LOG_LEVEL_RE_FILTER instead?
1976                    */
1977                   log_error(LOG_LEVEL_ERROR, "Skipped filter \'%s\' after job number %u: %s (%d)",
1978                      b->name, job_number, pcrs_strerror(job_hits), job_hits);
1979                   break;
1980                }
1981             }
1982
1983             if (b->dynamic) pcrs_free_joblist(joblist);
1984
1985             log_error(LOG_LEVEL_RE_FILTER,
1986                "filtering %s%s (size %d) with \'%s\' produced %d hits (new size %d).",
1987                csp->http->hostport, csp->http->path, prev_size, b->name, current_hits, size);
1988
1989             hits += current_hits;
1990          }
1991       }
1992    }
1993    }
1994
1995    /*
1996     * If there were no hits, destroy our copy and let
1997     * chat() use the original in csp->iob
1998     */
1999    if (!hits)
2000    {
2001       freez(new);
2002       return(NULL);
2003    }
2004
2005    csp->flags |= CSP_FLAG_MODIFIED;
2006    csp->content_length = size;
2007    IOB_RESET(csp);
2008
2009    return(new);
2010
2011 }
2012
2013
2014 /*********************************************************************
2015  *
2016  * Function    :  gif_deanimate_response
2017  *
2018  * Description :  Deanimate the GIF image that has been accumulated in
2019  *                csp->iob->buf, set csp->content_length to the modified
2020  *                size and raise the CSP_FLAG_MODIFIED flag.
2021  *
2022  * Parameters  :
2023  *          1  :  csp = Current client state (buffers, headers, etc...)
2024  *
2025  * Returns     :  a pointer to the (newly allocated) modified buffer.
2026  *                or NULL in case something went wrong.
2027  *
2028  *********************************************************************/
2029 static char *gif_deanimate_response(struct client_state *csp)
2030 {
2031    struct binbuffer *in, *out;
2032    char *p;
2033    size_t size;
2034
2035    size = (size_t)(csp->iob->eod - csp->iob->cur);
2036
2037    if (  (NULL == (in =  (struct binbuffer *)zalloc(sizeof *in )))
2038       || (NULL == (out = (struct binbuffer *)zalloc(sizeof *out))) )
2039    {
2040       log_error(LOG_LEVEL_DEANIMATE, "failed! (no mem)");
2041       return NULL;
2042    }
2043
2044    in->buffer = csp->iob->cur;
2045    in->size = size;
2046
2047    if (gif_deanimate(in, out, strncmp("last", csp->action->string[ACTION_STRING_DEANIMATE], 4)))
2048    {
2049       log_error(LOG_LEVEL_DEANIMATE, "failed! (gif parsing)");
2050       freez(in);
2051       buf_free(out);
2052       return(NULL);
2053    }
2054    else
2055    {
2056       if ((int)size == out->offset)
2057       {
2058          log_error(LOG_LEVEL_DEANIMATE, "GIF not changed.");
2059       }
2060       else
2061       {
2062          log_error(LOG_LEVEL_DEANIMATE, "Success! GIF shrunk from %d bytes to %d.", size, out->offset);
2063       }
2064       csp->content_length = out->offset;
2065       csp->flags |= CSP_FLAG_MODIFIED;
2066       p = out->buffer;
2067       freez(in);
2068       freez(out);
2069       return(p);
2070    }
2071
2072 }
2073
2074
2075 /*********************************************************************
2076  *
2077  * Function    :  get_filter_function
2078  *
2079  * Description :  Decides which content filter function has
2080  *                to be applied (if any).
2081  *
2082  * Parameters  :
2083  *          1  :  csp = Current client state (buffers, headers, etc...)
2084  *
2085  * Returns     :  The content filter function to run, or
2086  *                NULL if no content filter is active
2087  *
2088  *********************************************************************/
2089 filter_function_ptr get_filter_function(struct client_state *csp)
2090 {
2091    filter_function_ptr filter_function = NULL;
2092
2093    /*
2094     * Are we enabling text mode by force?
2095     */
2096    if (csp->action->flags & ACTION_FORCE_TEXT_MODE)
2097    {
2098       /*
2099        * Do we really have to?
2100        */
2101       if (csp->content_type & CT_TEXT)
2102       {
2103          log_error(LOG_LEVEL_HEADER, "Text mode is already enabled.");   
2104       }
2105       else
2106       {
2107          csp->content_type |= CT_TEXT;
2108          log_error(LOG_LEVEL_HEADER, "Text mode enabled by force. Take cover!");   
2109       }
2110    }
2111
2112    if (!(csp->content_type & CT_DECLARED))
2113    {
2114       /*
2115        * The server didn't bother to declare a MIME-Type.
2116        * Assume it's text that can be filtered.
2117        *
2118        * This also regulary happens with 304 responses,
2119        * therefore logging anything here would cause
2120        * too much noise.
2121        */
2122       csp->content_type |= CT_TEXT;
2123    }
2124
2125    /*
2126     * Choose the applying filter function based on
2127     * the content type and action settings.
2128     */
2129    if ((csp->content_type & CT_TEXT) &&
2130        (csp->rlist != NULL) &&
2131        (!list_is_empty(csp->action->multi[ACTION_MULTI_FILTER])))
2132    {
2133       filter_function = pcrs_filter_response;
2134    }
2135    else if ((csp->content_type & CT_GIF)  &&
2136             (csp->action->flags & ACTION_DEANIMATE))
2137    {
2138       filter_function = gif_deanimate_response;
2139    }
2140
2141    return filter_function;
2142 }
2143
2144
2145 /*********************************************************************
2146  *
2147  * Function    :  remove_chunked_transfer_coding
2148  *
2149  * Description :  In-situ remove the "chunked" transfer coding as defined
2150  *                in rfc2616 from a buffer.
2151  *
2152  * Parameters  :
2153  *          1  :  buffer = Pointer to the text buffer
2154  *          2  :  size =  In: Number of bytes to be processed,
2155  *                       Out: Number of bytes after de-chunking.
2156  *                       (undefined in case of errors)
2157  *
2158  * Returns     :  JB_ERR_OK for success,
2159  *                JB_ERR_PARSE otherwise
2160  *
2161  *********************************************************************/
2162 static jb_err remove_chunked_transfer_coding(char *buffer, size_t *size)
2163 {
2164    size_t newsize = 0;
2165    unsigned int chunksize = 0;
2166    char *from_p, *to_p;
2167
2168    assert(buffer);
2169    from_p = to_p = buffer;
2170
2171    if (sscanf(buffer, "%x", &chunksize) != 1)
2172    {
2173       log_error(LOG_LEVEL_ERROR, "Invalid first chunksize while stripping \"chunked\" transfer coding");
2174       return JB_ERR_PARSE;
2175    }
2176
2177    while (chunksize > 0)
2178    {
2179       if (NULL == (from_p = strstr(from_p, "\r\n")))
2180       {
2181          log_error(LOG_LEVEL_ERROR, "Parse error while stripping \"chunked\" transfer coding");
2182          return JB_ERR_PARSE;
2183       }
2184
2185       if ((newsize += chunksize) >= *size)
2186       {
2187          log_error(LOG_LEVEL_ERROR, "Chunksize exceeds buffer in  \"chunked\" transfer coding");
2188          return JB_ERR_PARSE;
2189       }
2190       from_p += 2;
2191
2192       memmove(to_p, from_p, (size_t) chunksize);
2193       to_p = buffer + newsize;
2194       from_p += chunksize + 2;
2195
2196       if (sscanf(from_p, "%x", &chunksize) != 1)
2197       {
2198          log_error(LOG_LEVEL_INFO, "Invalid \"chunked\" transfer encoding detected and ignored.");
2199          break;
2200       }
2201    }
2202    
2203    /* XXX: Should get its own loglevel. */
2204    log_error(LOG_LEVEL_RE_FILTER, "De-chunking successful. Shrunk from %d to %d", *size, newsize);
2205
2206    *size = newsize;
2207
2208    return JB_ERR_OK;
2209
2210 }
2211
2212
2213 /*********************************************************************
2214  *
2215  * Function    :  prepare_for_filtering
2216  *
2217  * Description :  If necessary, de-chunks and decompresses
2218  *                the content so it can get filterd.
2219  *
2220  * Parameters  :
2221  *          1  :  csp = Current client state (buffers, headers, etc...)
2222  *
2223  * Returns     :  JB_ERR_OK for success,
2224  *                JB_ERR_PARSE otherwise
2225  *
2226  *********************************************************************/
2227 static jb_err prepare_for_filtering(struct client_state *csp)
2228 {
2229    jb_err err = JB_ERR_OK;
2230
2231    /*
2232     * If the body has a "chunked" transfer-encoding,
2233     * get rid of it, adjusting size and iob->eod
2234     */
2235    if (csp->flags & CSP_FLAG_CHUNKED)
2236    {
2237       size_t size = (size_t)(csp->iob->eod - csp->iob->cur);
2238
2239       log_error(LOG_LEVEL_RE_FILTER, "Need to de-chunk first");
2240       err = remove_chunked_transfer_coding(csp->iob->cur, &size);
2241       if (JB_ERR_OK == err)
2242       {
2243          csp->iob->eod = csp->iob->cur + size;
2244          csp->flags |= CSP_FLAG_MODIFIED;
2245       }
2246       else
2247       {
2248          return JB_ERR_PARSE;
2249       }
2250    }
2251
2252 #ifdef FEATURE_ZLIB
2253    /*
2254     * If the body has a supported transfer-encoding,
2255     * decompress it, adjusting size and iob->eod.
2256     */
2257    if (csp->content_type & (CT_GZIP|CT_DEFLATE))
2258    {
2259       if (0 == csp->iob->eod - csp->iob->cur)
2260       {
2261          /* Nothing left after de-chunking. */
2262          return JB_ERR_OK;
2263       }
2264
2265       err = decompress_iob(csp);
2266
2267       if (JB_ERR_OK == err)
2268       {
2269          csp->flags |= CSP_FLAG_MODIFIED;
2270          csp->content_type &= ~CT_TABOO;
2271       }
2272       else
2273       {
2274          /*
2275           * Unset CT_GZIP and CT_DEFLATE to remember not
2276           * to modify the Content-Encoding header later.
2277           */
2278          csp->content_type &= ~CT_GZIP;
2279          csp->content_type &= ~CT_DEFLATE;
2280       }
2281    }
2282 #endif
2283
2284    return err;
2285 }
2286
2287
2288 /*********************************************************************
2289  *
2290  * Function    :  execute_content_filter
2291  *
2292  * Description :  Executes a given content filter.
2293  *
2294  * Parameters  :
2295  *          1  :  csp = Current client state (buffers, headers, etc...)
2296  *          2  :  content_filter = The filter function to execute
2297  *
2298  * Returns     :  Pointer to the modified buffer, or
2299  *                NULL if filtering failed or wasn't necessary.
2300  *
2301  *********************************************************************/
2302 char *execute_content_filter(struct client_state *csp, filter_function_ptr content_filter)
2303 {
2304    if (0 == csp->iob->eod - csp->iob->cur)
2305    {
2306       /*
2307        * No content (probably status code 301, 302 ...),
2308        * no filtering necessary.
2309        */
2310       return NULL;
2311    }
2312
2313    if (JB_ERR_OK != prepare_for_filtering(csp))
2314    {
2315       /*
2316        * failed to de-chunk or decompress.
2317        */
2318       return NULL;
2319    }
2320
2321    if (0 == csp->iob->eod - csp->iob->cur)
2322    {
2323       /*
2324        * Clown alarm: chunked and/or compressed nothing delivered.
2325        */
2326       return NULL;
2327    }
2328
2329    return ((*content_filter)(csp));
2330 }
2331
2332
2333 /*********************************************************************
2334  *
2335  * Function    :  get_url_actions
2336  *
2337  * Description :  Gets the actions for this URL.
2338  *
2339  * Parameters  :
2340  *          1  :  csp = Current client state (buffers, headers, etc...)
2341  *          2  :  http = http_request request for blocked URLs
2342  *
2343  * Returns     :  N/A
2344  *
2345  *********************************************************************/
2346 void get_url_actions(struct client_state *csp, struct http_request *http)
2347 {
2348    struct file_list *fl;
2349    struct url_actions *b;
2350    int i;
2351
2352    init_current_action(csp->action);
2353
2354    for (i = 0; i < MAX_AF_FILES; i++)
2355    {
2356       if (((fl = csp->actions_list[i]) == NULL) || ((b = fl->f) == NULL))
2357       {
2358          return;
2359       }
2360
2361       apply_url_actions(csp->action, http, b);
2362    }
2363
2364    return;
2365 }
2366
2367
2368 /*********************************************************************
2369  *
2370  * Function    :  apply_url_actions
2371  *
2372  * Description :  Applies a list of URL actions.
2373  *
2374  * Parameters  :
2375  *          1  :  action = Destination.
2376  *          2  :  http = Current URL
2377  *          3  :  b = list of URL actions to apply
2378  *
2379  * Returns     :  N/A
2380  *
2381  *********************************************************************/
2382 void apply_url_actions(struct current_action_spec *action,
2383                        struct http_request *http,
2384                        struct url_actions *b)
2385 {
2386    if (b == NULL)
2387    {
2388       /* Should never happen */
2389       return;
2390    }
2391
2392    for (b = b->next; NULL != b; b = b->next)
2393    {
2394       if (url_match(b->url, http))
2395       {
2396          merge_current_action(action, b->action);
2397       }
2398    }
2399 }
2400
2401
2402 /*********************************************************************
2403  *
2404  * Function    :  get_forward_override_settings
2405  *
2406  * Description :  Returns forward settings as specified with the
2407  *                forward-override{} action. forward-override accepts
2408  *                forward lines similar to the one used in the
2409  *                configuration file, but without the URL pattern.
2410  *
2411  *                For example:
2412  *
2413  *                   forward / .
2414  *
2415  *                in the configuration file can be replaced with
2416  *                the action section:
2417  *
2418  *                 {+forward-override{forward .}}
2419  *                 /
2420  *
2421  * Parameters  :
2422  *          1  :  csp = Current client state (buffers, headers, etc...)
2423  *
2424  * Returns     :  Pointer to forwarding structure in case of success.
2425  *                Invalid syntax is fatal.
2426  *
2427  *********************************************************************/
2428 const static struct forward_spec *get_forward_override_settings(struct client_state *csp)
2429 {
2430    const char *forward_override_line = csp->action->string[ACTION_STRING_FORWARD_OVERRIDE];
2431    char forward_settings[BUFFER_SIZE];
2432    char *http_parent = NULL;
2433    /* variable names were chosen for consistency reasons. */
2434    struct forward_spec *fwd = NULL;
2435    int vec_count;
2436    char *vec[3];
2437
2438    assert(csp->action->flags & ACTION_FORWARD_OVERRIDE);
2439    /* Should be enforced by load_one_actions_file() */
2440    assert(strlen(forward_override_line) < sizeof(forward_settings) - 1);
2441
2442    /* Create a copy ssplit can modify */
2443    strlcpy(forward_settings, forward_override_line, sizeof(forward_settings));
2444
2445    if (NULL != csp->fwd)
2446    {
2447       /*
2448        * XXX: Currently necessary to prevent memory
2449        * leaks when the show-url-info cgi page is visited.
2450        */
2451       unload_forward_spec(csp->fwd);
2452    }
2453
2454    /*
2455     * allocate a new forward node, valid only for
2456     * the lifetime of this request. Save its location
2457     * in csp as well, so sweep() can free it later on.
2458     */
2459    fwd = csp->fwd = zalloc(sizeof(*fwd));
2460    if (NULL == fwd)
2461    {
2462       log_error(LOG_LEVEL_FATAL,
2463          "can't allocate memory for forward-override{%s}", forward_override_line);
2464       /* Never get here - LOG_LEVEL_FATAL causes program exit */
2465    }
2466
2467    vec_count = ssplit(forward_settings, " \t", vec, SZ(vec), 1, 1);
2468    if ((vec_count == 2) && !strcasecmp(vec[0], "forward"))
2469    {
2470       fwd->type = SOCKS_NONE;
2471
2472       /* Parse the parent HTTP proxy host:port */
2473       http_parent = vec[1];
2474
2475    }
2476    else if (vec_count == 3)
2477    {
2478       char *socks_proxy = NULL;
2479
2480       if  (!strcasecmp(vec[0], "forward-socks4"))
2481       {
2482          fwd->type = SOCKS_4;
2483          socks_proxy = vec[1];
2484       }
2485       else if (!strcasecmp(vec[0], "forward-socks4a"))
2486       {
2487          fwd->type = SOCKS_4A;
2488          socks_proxy = vec[1];
2489       }
2490       else if (!strcasecmp(vec[0], "forward-socks5"))
2491       {
2492          fwd->type = SOCKS_5;
2493          socks_proxy = vec[1];
2494       }
2495
2496       if (NULL != socks_proxy)
2497       {
2498          /* Parse the SOCKS proxy host[:port] */
2499          fwd->gateway_host = strdup(socks_proxy);
2500
2501          if (NULL != (socks_proxy = strchr(fwd->gateway_host, ':')))
2502          {
2503             *socks_proxy++ = '\0';
2504             fwd->gateway_port = strtol(socks_proxy, NULL, 0);
2505          }
2506
2507          if (fwd->gateway_port <= 0)
2508          {
2509             fwd->gateway_port = 1080;
2510          }
2511
2512          http_parent = vec[2];
2513       }
2514    }
2515
2516    if (NULL == http_parent)
2517    {
2518       log_error(LOG_LEVEL_FATAL,
2519          "Invalid forward-override syntax in: %s", forward_override_line);
2520       /* Never get here - LOG_LEVEL_FATAL causes program exit */
2521    }
2522
2523    /* Parse http forwarding settings */
2524    if (strcmp(http_parent, ".") != 0)
2525    {
2526       fwd->forward_host = strdup(http_parent);
2527
2528       if (NULL != (http_parent = strchr(fwd->forward_host, ':')))
2529       {
2530          *http_parent++ = '\0';
2531          fwd->forward_port = strtol(http_parent, NULL, 0);
2532       }
2533
2534       if (fwd->forward_port <= 0)
2535       {
2536          fwd->forward_port = 8000;
2537       }
2538    }
2539
2540    assert (NULL != fwd);
2541
2542    log_error(LOG_LEVEL_CONNECT,
2543       "Overriding forwarding settings based on \'%s\'", forward_override_line);
2544
2545    return fwd;
2546 }
2547
2548
2549 /*********************************************************************
2550  *
2551  * Function    :  forward_url
2552  *
2553  * Description :  Should we forward this to another proxy?
2554  *
2555  * Parameters  :
2556  *          1  :  csp = Current client state (buffers, headers, etc...)
2557  *          2  :  http = http_request request for current URL
2558  *
2559  * Returns     :  Pointer to forwarding information.
2560  *
2561  *********************************************************************/
2562 const struct forward_spec *forward_url(struct client_state *csp,
2563                                        const struct http_request *http)
2564 {
2565    static const struct forward_spec fwd_default[1] = { FORWARD_SPEC_INITIALIZER };
2566    struct forward_spec *fwd = csp->config->forward;
2567
2568    if (csp->action->flags & ACTION_FORWARD_OVERRIDE)
2569    {
2570       return get_forward_override_settings(csp);
2571    }
2572
2573    if (fwd == NULL)
2574    {
2575       return fwd_default;
2576    }
2577
2578    while (fwd != NULL)
2579    {
2580       if (url_match(fwd->url, http))
2581       {
2582          return fwd;
2583       }
2584       fwd = fwd->next;
2585    }
2586
2587    return fwd_default;
2588 }
2589
2590
2591 /*********************************************************************
2592  *
2593  * Function    :  direct_response 
2594  *
2595  * Description :  Check if Max-Forwards == 0 for an OPTIONS or TRACE
2596  *                request and if so, return a HTTP 501 to the client.
2597  *
2598  *                FIXME: I have a stupid name and I should handle the
2599  *                requests properly. Still, what we do here is rfc-
2600  *                compliant, whereas ignoring or forwarding are not.
2601  *
2602  * Parameters  :  
2603  *          1  :  csp = Current client state (buffers, headers, etc...)
2604  *
2605  * Returns     :  http_response if , NULL if nonmatch or handler fail
2606  *
2607  *********************************************************************/
2608 struct http_response *direct_response(struct client_state *csp)
2609 {
2610    struct http_response *rsp;
2611    struct list_entry *p;
2612
2613    if ((0 == strcmpic(csp->http->gpc, "trace"))
2614       || (0 == strcmpic(csp->http->gpc, "options")))
2615    {
2616       for (p = csp->headers->first; (p != NULL) ; p = p->next)
2617       {
2618          if (!strncmpic("Max-Forwards:", p->str, 13))
2619          {
2620             unsigned int max_forwards;
2621
2622             /*
2623              * If it's a Max-Forwards value of zero,
2624              * we have to intercept the request.
2625              */
2626             if (1 == sscanf(p->str+12, ": %u", &max_forwards) && max_forwards == 0)
2627             {
2628                /*
2629                 * FIXME: We could handle at least TRACE here,
2630                 * but that would require a verbatim copy of
2631                 * the request which we don't have anymore
2632                 */
2633                 log_error(LOG_LEVEL_HEADER,
2634                   "Detected header \'%s\' in OPTIONS or TRACE request. Returning 501.",
2635                   p->str);
2636
2637                /* Get mem for response or fail*/
2638                if (NULL == (rsp = alloc_http_response()))
2639                {
2640                   return cgi_error_memory();
2641                }
2642             
2643                if (NULL == (rsp->status = strdup("501 Not Implemented")))
2644                {
2645                   free_http_response(rsp);
2646                   return cgi_error_memory();
2647                }
2648
2649                rsp->is_static = 1;
2650                rsp->reason = RSP_REASON_UNSUPPORTED;
2651
2652                return(finish_http_response(csp, rsp));
2653             }
2654          }
2655       }
2656    }
2657    return NULL;
2658 }
2659
2660
2661 /*********************************************************************
2662  *
2663  * Function    :  content_filters_enabled
2664  *
2665  * Description :  Checks whether there are any content filters
2666  *                enabled for the current request.
2667  *
2668  * Parameters  :  
2669  *          1  :  action = Action spec to check.
2670  *
2671  * Returns     :  TRUE for yes, FALSE otherwise
2672  *
2673  *********************************************************************/
2674 int content_filters_enabled(const struct current_action_spec *action)
2675 {
2676    return ((action->flags & ACTION_DEANIMATE) ||
2677       !list_is_empty(action->multi[ACTION_MULTI_FILTER]));
2678 }
2679
2680 /*
2681   Local Variables:
2682   tab-width: 3
2683   end:
2684 */