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