Last minute ChangeLog changes that didn't make it into the tarball
[privoxy.git] / doc / webserver / announce.txt
1               Announcing Privoxy v.3.0.18 stable
2 --------------------------------------------------------------------
3
4 This is mainly a bug-fix release for the previously released
5 Privoxy 3.0.17. One of the fixes addresses a security issue.
6
7 --------------------------------------------------------------------
8 ChangeLog for Privoxy
9 --------------------------------------------------------------------
10 *** Version 3.0.18 stable ***
11
12 - Bug fixes:
13   - If a generated redirect URL contains characters RFC 3986 doesn't
14     permit, they are (re)encoded. Not doing this makes Privoxy versions
15     from 3.0.5 to 3.0.17 susceptible to HTTP response splitting (CWE-113)
16     attacks if the +fast-redirects{check-decoded-url} action is used.
17   - Fix a logic bug that could cause Privoxy to reuse a server
18     socket after it got tainted by a server-header-tagger-induced
19     block that was triggered before the whole server response had
20     been read. If keep-alive was enabled and the request following
21     the blocked one was to the same host and using the same forwarding
22     settings, Privoxy would send it on the tainted server socket.
23     While the server would simply treat it as a pipelined request,
24     Privoxy would later on fail to properly parse the server's
25     response as it would try to parse the unread data from the
26     first response as server headers for the second one.
27     Regression introduced in 3.0.17.
28   - When implying keep-alive in client_connection(), remember that
29     the client didn't. Fixes a regression introduced in 3.0.13 that
30     would cause Privoxy to wait for additional client requests after
31     receiving a HTTP/1.1 request with "Connection: close" set
32     and connection sharing enabled.
33     With clients which terminates the client connection after detecting
34     that the whole body has been received it doesn't really matter,
35     but with clients that don't the connection would be kept open until
36     it timed out.
37   - Fix a subtle race condition between prepare_csp_for_next_request()
38     and sweep(). A thread preparing itself for the next client request
39     could briefly appear to be inactive.
40     If all other threads were already using more recent files,
41     the thread could get its files swept away under its feet.
42     So far this has only been reproduced while stress testing in
43     valgrind while touching action files in a loop. It's unlikely
44     to have caused any actual problems in the real world.
45   - Disable filters if SDCH compression is used unless filtering is forced.
46     If SDCH was combined with a supported compression algorithm, Privoxy
47     previously could try to decompress it and ditch the Content-Encoding
48     header even though the SDCH compression wasn't dealt with.
49     Reported by zebul666 in #3225863.
50   - Make a copy of the --user value and only mess with that when splitting
51     user and group. On some operating systems modifying the value directly
52     is reflected in the output of ps and friends and can be misleading.
53     Reported by zepard in #3292710.
54   - If forwarded-connect-retries is set, only retry if Privoxy is actually
55     forwarding the request. Previously direct connections would be retried
56     as well.
57   - Fixed a small memory leak when retrying connections with IPv6
58     support enabled.
59   - Remove an incorrect assertion in compile_dynamic_pcrs_job_list()
60     It could be triggered by a pcrs job with an invalid pcre
61     pattern (for example one that contains a lone quantifier).
62   - If the --user argument user[.group] contains a dot, always bail out
63     if no group has been specified. Previously the intended, but undocumented
64     (and apparently untested), behaviour was to try interpreting the whole
65     argument as user name, but the detection was flawed and checked for '0'
66     instead of '\0', thus merely preventing group names beginning with a zero.
67   - In html_code_map[], use a numeric character reference instead of '
68     which wasn't standardized before XHTML 1.0.
69   - Fix an invalid free when compiled with FEATURE_GRACEFUL_TERMINATION
70     and shut down through http://config.privoxy.org/die
71   - In get_actions(), fix the "temporary" backwards compatibility hack
72     to accept block actions without reason.
73     It also covered other actions that should be rejected as invalid.
74     Reported by Billy Crook.
75
76 - General improvements:
77   - Privoxy can (re)compress buffered content before delivering
78     it to the client. Disabled by default as most users wouldn't
79     benefit from it.
80   - The +fast-redirects{check-decoded-url} action checks URL
81     segments separately. If there are other parameters behind
82     the redirect URL, this makes it unnecessary to cut them off
83     by additionally using a +redirect{} pcrs command.
84     Initial patch submitted by Jamie Zawinski in #3429848.
85   - When loading action sections, verify that the referenced filters
86     exist. Currently missing filters only result in an error message,
87     but eventually the severity will be upgraded to fatal.
88   - Allow to bind to multiple separate addresses.
89     Patch set submitted by Petr Pisar in #3354485.
90   - Set socket_error to errno if connecting fails in rfc2553_connect_to().
91     Previously rejected direct connections could be incorrectly reported
92     as DNS issues if Privoxy was compiled with IPv6 support.
93   - Adjust url_code_map[] so spaces are replaced with %20 instead of '+'
94     While '+' can be used by client's submitting form data, this is not
95     actually what Privoxy is using the lookups for. This is more of a
96     cosmetic issue and doesn't fix any known problems.
97   - When compiled without FEATURE_FAST_REDIRECTS, do not silently
98     ignore +fast-redirect{} directives
99   - Added a workaround for GNU libc's strptime() reporting negative
100     year values when the parsed year is only specified with two digits.
101     On affected systems cookies with such a date would not be turned
102     into session cookies by the +session-cookies-only action.
103     Reported by Vaeinoe in #3403560
104   - Fixed bind failures with certain GNU libc versions if no non-loopback
105     IP address has been configured on the system. This is mainly an issue
106     if the system is using DHCP and Privoxy is started before the network
107     is completely configured.
108     Reported by Raphael Marichez in #3349356.
109     Additional insight from Petr Pisar.
110   - Privoxy log messages now use the ISO 8601 date format %Y-%m-%d.
111     It's only slightly longer than the old format, but contains
112     the full date including the year and allows sorting by date
113     (when grepping in multiple log files) without hassle.
114   - In get_last_url(), do not bother trying to decode URLs that do
115     not contain at least one '%' sign. It reduces the log noise and
116     a number of unnecessary memory allocations.
117   - In case of SOCKS5 failures, dump the socks response in the log message.
118   - Simplify the signal setup in main().
119   - Streamline socks5_connect() slightly.
120   - In socks5_connect(), require a complete socks response from the server.
121     Previously Privoxy didn't care how much data the server response
122     contained as long as the first two bytes contained the expected
123     values. While at it, shrink the buffer size so Privoxy can't read
124     more than a whole socks response.
125   - In chat(), do not bother to generate a client request in case of
126     direct CONNECT requests. It will not be used anyway.
127   - Reduce server_last_modified()'s stack size.
128   - Shorten get_http_time() by using strftime().
129   - Constify the known_http_methods pointers in unknown_method().
130   - Constify the time_formats pointers in parse_header_time().
131   - Constify the formerly_valid_actions pointers in action_used_to_be_valid().
132   - Introduce a GNUMakefile MAN_PAGE variable that defaults to privoxy.1.
133     The Debian package uses section 8 for the man page and this
134     should simplify the patch.
135   - Deduplicate the INADDR_NONE definition for Solaris by moving it to jbsockets.h
136   - In block_url(), ditch the obsolete workaround for ancient Netscape versions
137     that supposedly couldn't properly deal with status code 403.
138   - Remove a useless NULL pointer check in load_trustfile().
139   - Remove two useless NULL pointer checks in load_one_re_filterfile().
140   - Change url_code_map[] from an array of pointers to an array of arrays
141     It removes an unnecessary layer of indirection and on 64bit system reduces
142     the size of the binary a bit.
143   - Fix various typos. Fixes taken from Debian's 29_typos.dpatch by Roland Rosenfeld.
144   - Add a dok-tidy GNUMakefile target to clean up the messy HTML
145     generated by the other dok targets.
146   - GNUisms in the GNUMakefile have been removed.
147   - Change the HTTP version in static responses to 1.1
148   - Synced config.sub and config.guess with upstream
149     2011-11-11/386c7218162c145f5f9e1ff7f558a3fbb66c37c5.
150   - Add a dedicated function to parse the values of toggles. Reduces duplicated
151     code in load_config() and provides better error handling. Invalid or missing
152     toggle values are now a fatal error instead of being silently ignored.
153   - Terminate HTML lines in static error messages with \n instead of \r\n.
154   - Simplify cgi_error_unknown() a bit.
155   - In LogPutString(), don't bother looking at pszText when not
156     actually logging anything.
157   - Change ssplit()'s fourth parameter from int to size_t.
158     Fixes a clang complaint.
159   - Add a warning that the statistics currently can't be trusted.
160     Mention Privoxy-Log-Parser's --statistics option as
161     an alternative for the time being.
162   - In rfc2553_connect_to(), start setting cgi->error_message on error.
163   - Change the expected status code returned for http://p.p/die depending
164     on whether or not FEATURE_GRACEFUL_TERMINATION is available.
165   - In cgi_die(), mark the client connection for closing.
166     If the client will fetch the style sheet through another connection
167     it gets the main thread out of the accept() state and should thus
168     trigger the actual shutdown.
169   - Add a proper CGI message for cgi_die().
170   - Don't enforce a logical line length limit in read_config_line().
171   - Slightly refactor server_last_modified() to remove useless gmtime*() calls.
172   - In get_content_type(), also recognize '.jpeg' as JPEG extension.
173   - Add '.png' to the list of recognized file extensions in get_content_type().
174   - In block_url(), consistently use the block reason "Request blocked by Privoxy"
175     In two places the reason was "Request for blocked URL" which hides the
176     fact that the request got blocked by Privoxy and isn't necessarily
177     correct as the block may be due to tags.
178   - In listen_loop(), reload the configuration files after accepting
179     a new connection instead of before.
180     Previously the first connection that arrived after a configuration
181     change would still be handled with the old configuration.
182   - In chat()'s receive-data loop, skip a client socket check if
183     the socket will be written to right away anyway. This can
184     increase the transfer speed for unfiltered content on fast
185     network connections.
186   - The socket timeout is used for SOCKS negotiations as well which
187     previously couldn't timeout.
188   - Don't keep the client connection alive if any configuration file
189     changed since the time the connection came in. This is closer to
190     Privoxy's behaviour before keep-alive support for client connection
191     has been added and also less confusing in general.
192   - Treat all Content-Type header values containing the pattern
193     'script' as a sign of text. Reported by pribog in #3134970.
194
195 - Action file improvements:
196   - Moved the site-specific block pattern section below the one for the
197     generic patterns so for requests that are matched in both, the block
198     reason for the domain is shown which is usually more useful than showing
199     the one for the generic pattern.
200   - Remove -prevent-compression from the fragile alias. It's no longer
201     used anywhere by default and isn't known to break stuff anyway.
202   - Add a (disabled) section to block various Facebook tracking URLs.
203     Reported by Dan Stahlke in #3421764.
204   - Add a (disabled) section to rewrite and redirect click-tracking
205     URLs used on news.google.com.
206     Reported by Dan Stahlke in #3421755.
207   - Unblock linuxcounter.net/.
208     Reported by Dan Stahlke in #3422612.
209   - Block 'www91.intel.com/' which is used by Omniture.
210     Reported by Adam Piggott in #3167370.
211   - Disable the handle-as-empty-doc-returns-ok option and mark it as deprecated.
212     Reminded by tceverling in #2790091.
213   - Add ".ivwbox.de/" to the "Cross-site user tracking" section.
214     Reported by Nettozahler in #3172525.
215   - Unblock and fast-redirect ".awin1.com/.*=http://".
216     Reported by Adam Piggott in #3170921.
217   - Block "b.collective-media.net/".
218   - Widen the Debian popcon exception to "qa.debian.org/popcon".
219     Seen in Debian's 05_default_action.dpatch by Roland Rosenfeld.
220   - Block ".gemius.pl/" which only seems to be used for user tracking.
221     Reported by johnd16 in #3002731. Additional input from Lee and movax.
222   - Disable banners-by-size filters for '.thinkgeek.com/'.
223     The filter only seems to catch pictures of the inventory.
224   - Block requests for 'go.idmnet.bbelements.com/please/showit/'.
225     Reported by kacperdominik in #3372959.
226   - Unblock adainitiative.org/.
227   - Add a fast-redirects exception for '.googleusercontent.com/.*=cache'.
228   - Add a fast-redirects exception for webcache.googleusercontent.com/.
229   - Unblock http://adassier.wordpress.com/ and http://adassier.files.wordpress.com/.
230
231 - Filter file improvements:
232   - Let the yahoo filter hide '.ads'.
233   - Let the msn filter hide overlay ads for Facebook 'likes' in search
234     results and elements with the id 's_notf_div'. They only seem to be
235     used to advertise site 'enhancements'.
236   - Let the js-events filter additionally disarm setInterval().
237     Suggested by dg1727 in #3423775.
238
239 - Documentation improvements:
240   - Clarify the effect of compiling Privoxy with zlib support.
241     Suggested by dg1727 in #3423782.
242   - Point out that the SourceForge messaging system works like a black
243     hole and should thus not be used to contact individual developers.
244   - Mention some of the problems one can experience when not explicitly
245     configuring an IP addresses as listen address.
246   - Explicitly mention that hostnames can be used instead of IP addresses
247     for the listen-address, that only the first address returned will be
248     used and what happens if the address is invalid.
249     Requested by Calestyo in #3302213.
250
251 - Log message improvements:
252   - If only the server connection is kept alive, do not pretend to
253     wait for a new client request.
254   - Remove a superfluous log message in forget_connection().
255   - In chat(), properly report missing server responses as such
256     instead of calling them empty.
257   - In forwarded_connect(), fix a log message nobody should ever see.
258   - Fix a log message in socks5_connect(), a failed write operation
259     was logged as failed read operation.
260   - Let load_one_actions_file() properly complain about a missing
261     '{' at the beginning of the file.
262     Simply stating that a line is invalid isn't particularly helpful.
263   - Do not claim to listen on a socket until Privoxy actually does.
264     Patch submitted by Petr Pisar #3354485
265   - Prevent a duplicated LOG_LEVEL_CLF message when sending out
266     the "no-server-data" response.
267   - Also log the client socket when dropping a connection.
268   - Include the destination host in the 'Request ... marked for
269     blocking. limit-connect{...} doesn't allow CONNECT ...' message
270     Patch submitted by Saperski in #3296250.
271   - Prevent a duplicated log message if none of the resolved IP
272     addresses were reachable.
273   - In connect_to(), do not pretend to retry if forwarded-connect-retries
274     is zero or unset.
275   - When a specified user or group can't be found, put the name in
276     single-quotes when logging it.
277   - In rfc2553_connect_to(), explain getnameinfo() errors better.
278   - Remove a useless log message in chat().
279   - When retrying to connect, also log the maximum number of connection
280     attempts.
281   - Rephrase a log message in compile_dynamic_pcrs_job_list().
282     Divide the error code and its meaning with a colon. Call the pcrs
283     job dynamic and not the filter. Filters may contain dynamic and
284     non-dynamic pcrs jobs at the same time. Only mention the name of
285     the filter or tagger, but don't claim it's a filter when it could
286     be a tagger.
287   - In a fatal error message in load_one_actions_file(), cover both
288     URL and TAG patterns.
289   - In pcrs_strerror(), properly report unknown positive error code
290     values as such. Previously they were handled like 0 (no error).
291   - In compile_dynamic_pcrs_job_list(), also log the actual error code as
292     pcrs_strerror() doesn't handle all errors reported by pcre.
293   - Don't bother trying to continue chatting if the client didn't ask for it.
294     Reduces log noise a bit.
295   - Make two fatal error message in load_one_actions_file() more descriptive.
296   - In cgi_send_user_manual(), log when rejecting a file name due to '/' or '..'.
297   - In load_file(), log a message if opening a file failed.
298     The CGI error message alone isn't too helpful.
299   - In connection_destination_matches(), improve two log messages
300     to help understand why the destinations don't match.
301   - Rephrase a log message in serve(). Client request arrival
302     should be differentiated from closed client connections now.
303   - In serve(), log if a client connection isn't reused due to a
304     configuration file change.
305   - Let mark_server_socket_tainted() always mark the server socket tainted,
306     just don't talk about it in cases where it has no effect. It doesn't change
307     Privoxy's behaviour, but makes understanding the log file easier.
308
309 - configure:
310   - Added a --disable-ipv6-support switch for platforms where support
311     is detected but doesn't actually work.
312   - Do not check for the existence of strerror() and memmove() twice
313   - Remove a useless test for setpgrp(2). Privoxy doesn't need it and
314     it can cause problems when cross-compiling.
315   - Rename the --disable-acl-files switch to --disable-acl-support.
316     Since about 2001, ACL directives are specified in the standard
317     config file.
318   - Update the URL of the 'Removing outdated PCRE version after the
319     next stable release' posting. The old URL stopped working after
320     one of SF's recent site "optimizations". Reported by Han Liu.
321
322 - Privoxy-Regression-Test:
323   - Added --shuffle-tests option to increase the chances of detection race conditions.
324   - Added a --local-test-file option that allows to use Privoxy-Regression-Test without Privoxy.
325   - Added tests for missing socks4 and socks4a forwarders.
326   - The --privoxy-address option now works with IPv6 addresses containing brackets, too.
327   - Perform limited sanity checks for parameters that are supposed to have numerical values.
328   - Added a --sleep-time option to specify a number of seconds to
329     sleep between tests, defaults to 0.
330   - Disable the range-requests tagger for tests that break if it's enabled.
331   - Log messages use the ISO 8601 date format %Y-%m-%d.
332   - Fix spelling in two error messages.
333   - In the --help output, include a list of supported tests and their default levels.
334   - Adjust the tests to properly deal with FEATURE_TOGGLE being disabled.
335
336 - Privoxy-Log-Parser:
337   - Perform limited sanity checks for command line parameters that
338     are supposed to have numerical values.
339   - Implement a --unbreak-lines-only option to try to revert MUA breakage.
340   - Accept and highlight: Added header: Content-Encoding: deflate
341   - Accept and highlight: Compressed content from 29258 to 8630 bytes.
342   - Accept and highlight: Client request arrived in time on socket 21.
343   - Highlight: Didn't receive data in time: a.fsdn.com:443
344   - Accept log messages with ISO 8601 time stamps, too.
345
346 - uagen:
347   - Bump generated Firefox version to 8.0.
348   - Only randomize the release date if the new --randomize-release-date
349     option is enabled. Firefox versions after 4 use a fixed date string
350     without meaning.
351
352 -----------------------------------------------------------------
353 About Privoxy:
354 -----------------------------------------------------------------
355
356 Privoxy is a non-caching web proxy with advanced filtering capabilities for
357 enhancing privacy, modifying web page data and HTTP headers, controlling
358 access, and removing ads and other obnoxious Internet junk. Privoxy has a
359 flexible configuration and can be customized to suit individual needs and
360 tastes. It has application for both stand-alone systems and multi-user
361 networks.
362
363 Privoxy is Free Software and licensed under the GNU GPLv2.
364
365 Privoxy is an associated project of Software in the Public Interest (SPI).
366
367 Helping hands and donations are welcome:
368
369   * http://www.privoxy.org/faq/general.html#PARTICIPATE
370
371   * http://www.privoxy.org/faq/general.html#DONATE
372
373 At present, Privoxy is known to run on Windows(95, 98, ME, 2000,
374 XP, Vista), GNU/Linux (Ubuntu, RedHat, SuSE, Debian, Fedora, Gentoo and
375 others), Mac OSX, OS/2, AmigaOS, FreeBSD, NetBSD, OpenBSD, Solaris, and
376 various other flavors of Unix.
377
378 In addition to the core features of ad blocking and cookie management,
379 Privoxy provides many supplemental features, that give the end-user
380 more control, more privacy and more freedom:
381
382
383     *  Supports "Connection: keep-alive". Outgoing connections can be kept
384        alive independently from the client. Currently not available on all
385        platforms.
386
387     *  Supports IPv6, provided the operating system does so too,
388        and the configure script detects it.
389
390     *  Supports tagging which allows to change the behaviour based on client
391        and server headers.
392
393     *  Can be run as an "intercepting" proxy, which obviates the need to
394        configure browsers individually.
395
396     *  Sophisticated actions and filters for manipulating both server and
397        client headers.
398
399     *  Can be chained with other proxies.
400
401     *  Integrated browser based configuration and control utility at
402        http://config.privoxy.org/ (shortcut: http://p.p/). Browser-based
403        tracing of rule and filter effects. Remote toggling.
404
405     *  Web page filtering (text replacements, removes banners based on size,
406        invisible <quote>web-bugs</quote> and HTML annoyances, etc.)
407
408     *  Modularized configuration that allows for standard settings and user
409        settings to reside in separate files, so that installing updated actions
410        files won't overwrite individual user settings.
411
412     *  Support for Perl Compatible Regular Expressions in the configuration
413        files, and a more sophisticated and flexible configuration syntax.
414
415     *  GIF de-animation.
416
417     *  Bypass many click-tracking scripts (avoids script redirection).
418
419     *  User-customizable HTML templates for most proxy-generated pages (e.g.
420        "blocked" page).
421
422     *  Auto-detection and re-reading of config file changes.
423     
424     *  Most features are controllable on a per-site or per-location basis.
425     
426
427 Download location: 
428    http://sourceforge.net/project/showfiles.php?group_id=11118
429  
430 Home Page: 
431    http://www.privoxy.org/
432
433
434   - Privoxy Developers <ijbswa-developers@lists.sourceforge.net>