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