Prepare the announcement text for Privoxy 3.0.34 stable
[privoxy.git] / doc / webserver / announce.txt
index 799cd5a..35720d9 100644 (file)
-              Announcing Privoxy v.3.0.13 beta
------------------------------------------------------------------
-
-Privoxy 3.0.14 beta is a bugfix-release for the previous beta
-which introduced IPv6 support, improved keep-alive support and
-a bunch of minor improvements.
+               Announcing Privoxy 3.0.34 stable
+--------------------------------------------------------------------
 
-See http://www.privoxy.org/3.0.14/user-manual/whatsnew.html for details.
+Privoxy 3.0.34 fixes a few minor bugs and comes with a couple of
+general improvements and new features.
 
 --------------------------------------------------------------------
-ChangeLog for Privoxy
+ChangeLog for Privoxy 3.0.34
 --------------------------------------------------------------------
-*** Version 3.0.14 Beta ***
-
-- The latency is taken into account when evaluating whether or not to
-  reuse a connection. This should significantly reduce the number of
-  connections problems several users reported.
-- If the server doesn't specify how long the connection stays alive,
-  Privoxy errs on the safe side of caution and assumes it's only a second.
-- The error pages for connection timeouts or missing server data use a
-  Last-Modified date in the past. Retry attempts are detected and Privoxy
-  removes the If-Modified-Since header to prevent the server from responding
-  with status code 304 in which case the client would reuse the error message.
-- Setting keep-alive-timeout to 0 disables keep-alive support. Previously
-  Privoxy would claim to allow persistence but not reuse the connection.
-- Pipelined requests are less likely to be mistaken for the request
-  body of the previous request. Note that Privoxy still has no real
-  pipeline support and will either serialize pipelined requests or
-  drop them in which case the client has to resent them.
-- Fixed a crash on some Windows versions when header randomization
-  is enabled and the date couldn't be parsed.
-- Privoxy's keep-alive timeout for the current connection is reduced
-  to the one specified in the client's Keep-Alive header.
-- For HTTP/1.1 requests, Privoxy implies keep-alive support by not
-  setting any Connection header instead of using 'Connection: keep-alive'.
-- If the socket isn't reusable, Privoxy doesn't temporarily waste
-  a socket slot to remember the connection.
-- If keep-alive support is disabled but compiled in, the client's
-  Keep-Alive header is removed.
-- Fixed a bug on mingw32 where downloading large files failed if
-  keep-alive support was enabled.
-- Fixed a bug that (at least theoretically) could cause log
-  timestamps to be occasionally off by about a second.
-- No Proxy-Connection header if added if there already is one.
-- The configure script respects the $PATH variable when searching
-  for groups and id.
-
-*** Version 3.0.13 beta  ***
-
-- Added IPv6 support. Thanks to Petr Pisar who not only provided
-  the initial patch but also helped a lot with the integration.
-- Added client-side keep-alive support.
-- The connection sharing code is only used if the connection-sharing
-  option is enabled.
-- The max-client-connections option has been added to restrict
-  the number of client connections below a value enforced by
-  the operating system.
-- Fixed a regression reintroduced in 3.0.12 that could cause
-  crashes on mingw32 if header date randomization was enabled.
-- Compressed content with extra fields couldn't be decompressed
-  and would get passed to the client unfiltered. This problem
-  has only be detected through statical analysis with clang as
-  nobody seems to be using extra fields anyway.
-- If the server resets the Connection after sending only the headers
-  Privoxy forwards what it got to the client. Previously Privoxy
-  would deliver an error message instead.
-- Error messages in case of connection timeouts use the right
-  HTTP status code.
-- If spawning a child to handle a request fails, the client
-  gets an error message and Privoxy continues to listen for
-  new requests right away.
-- The error messages in case of server-connection timeouts or
-  prematurely closed server connections are now template-based.
-- If zlib support isn't compiled in, Privoxy no longer tries to
-  filter compressed content unless explicitly asked to do so.
-- In case of connections that are denied based on ACL directives,
-  the memory used for the client IP is no longer leaked.
-- Fixed another small memory leak if the client request times out
-  while waiting for client headers other than the request line.
-- The client socket is kept open until the server socket has
-  been marked as unused. This should increase the chances that
-  the still-open connection will be reused for the client's next
-  request to the same destination. Note that this only matters
-  if connection-sharing is enabled.
-- A TODO list has been added to the source tarballs to give potential
-  volunteers a better idea of what the current goals are.
+- Bug fixes:
+  - Improve the handling of chunk-encoded responses by buffering the data
+    even if filters are disabled and properly keeping track of where the
+    various chunks are supposed to start and end. Previously Privoxy would
+    merely check the last bytes received to see if they looked like the
+    last-chunk. This failed to work if the last-chunk wasn't received in one
+    read and could also result in actual data being misdetected
+    as last-chunk.
+    Should fix: SF support request #1739.
+    Reported by: withoutname.
+  - remove_chunked_transfer_coding(): Refuse to de-chunk invalid data
+    Previously the data could get corrupted even further.
+    Now we simply pass the unmodified data to the client.
+  - gif_deanimate(): Tolerate multiple image extensions in a row.
+    This allows to deanimate all the gifs on:
+    https://commons.wikimedia.org/wiki/Category:Animated_smilies
+    Fixes SF bug #795 reported by Celejar.
+  - OpenSSL generate_host_certificate(): Use X509_get_subject_name()
+    instead of X509_get_issuer_name() to get the issuer for generated
+    website certificates so there are no warnings in the browser when using
+    an intermediate CA certificate instead of a self-signed root certificate.
+    Problem reported and patch submitted by Chakib Benziane.
+  - can_filter_request_body(): Fix a log message that contained a spurious u.
+  - handle_established_connection(): Check for pending TLS data from the client
+    before checking if data is available on the connection.
+    The TLS library may have already consumed all the data from the client
+    response in which case poll() and select() will not detect that data is
+    available to be read.
+    Sponsored by: Robert Klemme.
+  - ssl_send_certificate_error(): Don't crash if there's no certificate
+    information available. This is only relevant when Privoxy is built with
+    wolfSSL 5.0.0 or later (code not yet published). Earlier wolfSSL versions
+    or the other TLS backends don't seem to trigger the crash.
+  - socks5_connect(): Add support for target hosts specified as IPv4 address
+    Previously the IP address was sent as domain.
+
+- General improvements:
+  - Add a client-body-tagger action which creates tags based on
+    the content of the request body.
+    Sponsored by: Robert Klemme.
+  - When client-body filters are enabled, buffer the whole request
+    before opening a connection to the server.
+    Makes it less likely that the server connection times out
+    and we don't open a connection if the buffering fails anyway.
+    Sponsored by: Robert Klemme.
+  - Add periods to a couple of log messages.
+  - accept_connection(): Add missing space to a log message.
+  - Initialize ca-related defaults with strdup_or_die() so errors
+    aren't silently ignored.
+  - make_path: Use malloc_or_die() in cases where allocation errors
+    were already fatal anyway.
+  - handle_established_connection(): Improve an error message slightly.
+  - receive_client_request(): Reject https URLs without CONNECT request.
+  - Include all requests in the statistics if mutexes are available.
+    Previously in case of reused connections only the last request got
+    counted. The statistics still aren't perfect but it's an improvement.
+  - Add read_socks_reply() and start using it in socks5_connect()
+    to apply the socket timeout more consistently.
+  - socks5_connect(): Deal with domain names in the socks reply
+  - Add a filter for bundeswehr.de that hides the cookie and
+    privacy info banner.
+
+- Action file improvements:
+  - Disable filter{banners-by-size} for .freiheitsfoo.de/.
+  - Disable filter{banners-by-size} for freebsdfoundation.org/.
+  - Disable fast-redirects for consent.youtube.com/.
+  - Block requests to ups.xplosion.de/.
+  - Block requests for elsa.memoinsights.com/t.
+  - Fix a typo in a test.
+  - Disable fast-redirects for launchpad.net/.
+  - Unblock .eff.org/.
+  - Stop unblocking .org/.*(image|banner) which appears to be too generous
+    It let requests like:
+    https://stats.noblogs.org/piwik.php?action_name=anti%20gentrifizierungs%20fest&idsite=10175&rec=1&r=220192&h=17&m=7&s=44&url=https%3A%2F%2Fmuellemcalling.noblogs.org%2F&urlref=https%3A%2F%2Fmuellemcalling.noblogs.org%2Finfostande%2F&_id=&_idn=1&_refts=0&send_image=0&cookie=1&res=1366x768&pv_id=eqr7jX&pf_net=7&pf_srv=3&pf_tfr=2281&pf_dm1=156
+    pass.
+    The example URL http://www.gnu.org/graphics/gnu-head-banner.png is
+    already unblocked due to .gnu.org being unblocked.
+  - Unblock adfd.org/.
+  - Disable filter{banners-by-link} for .eff.org/.
+  - Block requests to odb.outbrain.com/.
+  - Disable fast-redirects for .gandi.net/.
+  - Disable fast-redirects{} for .onion/.*/status/.
+  - Disable fast-redirects{} for twitter.com/.*/status/.
+  - Unblock pinkstinks.de/.
+  - Disable fast-redirects for .hagalil.com/.
+
+- Privoxy-Log-Parser:
+  - Bump version to 0.9.5.
+  - Highlight more log messages.
+  - Highlight the Crunch reason only once. Previously the "crunch reason"
+    could also be highlighted when the URL contained a matching string.
+    The real crunch reason only occurs once per line, so there's no need
+    to continue looking for it after it has been found once.
+    While at it, add a comment with an example log line.
+
+- uagen:
+  - Bump version to 1.2.4.
+  - Update BROWSER_VERSION and BROWSER_REVISION to 102.0
+    to match the User-Agent of the current Firefox ESR.
+  - Explicitly document that changing the 'Gecko token' is suspicious.
+  - Consistently use a lower-case 'c' as copyright symbol.
+  - Bump copyright.
+  - Add 'aarch64' as Linux architecture.
+  - Add OpenBSD architecture 'arm64'.
+  - Stop using sparc64 as FreeBSD architecture.
+    It hasn't been supported for a while now.
+
+- Build system:
+  - Makefile: Add a 'dok' target that depends on the 'error' target
+    to show the "You are not using GNU make or did nor run configure"
+    message.
+  - configure: Fix --with-msan option.
+    Also (probably) reported by Andrew Savchenko.
+
+- macOS build system:
+  - Enable HTTPS inspection when building the macOS binary
+    (using OpenSSL as TLS library).
+
+- Documentation:
+  - Add OpenSSL to the list of libraries that may be licensed under the
+    Apache 2.0 license in which case the linked Privoxy binary has to be
+    distributed under the GPLv3 or later.
+  - config: Fix the documented ca-directory default value.
+    Reported by avoidr.
+  - Rebuild developer-manual and tidy with 'HTML Tidy for FreeBSD version 5.8.0'.
+  - Update developer manual with new macOS packaging instructions.
+  - Note that the FreeBSD installation instructions work for
+    ElectroBSD as well.
+  - Note that FreeBSD/ElectroBSD users can try to install Privoxy
+    as binary package using 'pkg'.
 
 -----------------------------------------------------------------
 About Privoxy:
@@ -96,70 +149,72 @@ flexible configuration and can be customized to suit individual needs and
 tastes. It has application for both stand-alone systems and multi-user
 networks.
 
-Privoxy is Free Software and licensed under the GPL2.
+Privoxy is Free Software and licensed under the GNU GPLv2.
+
+Our TODO list is rather long. Helping hands and donations are welcome:
 
-Privoxy is an associated project of Software in the Public Interest (SPI).
-Donations are welcome: http://www.privoxy.org/faq/general.html#DONATE
+  * https://www.privoxy.org/participate
 
-At present, Privoxy is known to run on Windows(95, 98, ME, 2000,
-XP, Vista), Linux (Ubuntu, RedHat, SuSE, Debian, Fedora, Gentoo and
-others), Mac OSX, OS/2, AmigaOS, FreeBSD, NetBSD, OpenBSD, Solaris, and
-various other flavors of Unix.
+  * https://www.privoxy.org/donate
+
+At present, Privoxy is known to run on Windows 95 and later versions
+(98, ME, 2000, XP, Vista, Windows 7, Windows 10 etc.), GNU/Linux
+(RedHat, SuSE, Debian, Fedora, Gentoo, Slackware and others),
+Mac OS X (10.4 and upwards on PPC and Intel processors), Haiku,
+DragonFly, ElectroBSD, FreeBSD, NetBSD, OpenBSD, Solaris,
+and various other flavors of Unix.
 
 In addition to the core features of ad blocking and cookie management,
 Privoxy provides many supplemental features, that give the end-user
 more control, more privacy and more freedom:
 
+  *  Supports "Connection: keep-alive". Outgoing connections can be kept
+     alive independently from the client. Currently not available on all
+     platforms.
 
-    *  Supports "Connection: keep-alive". Outgoing connections can be kept
-       alive independently from the client. Currently not available on all
-       platforms.
+  *  Supports IPv6, provided the operating system does so too,
+     and the configure script detects it.
 
-    *  Supports IPv6, provided the operating system does so too,
-       and the configure script detects it.
+  *  Supports tagging which allows to change the behaviour based on client
+     and server headers.
 
-    *  Supports tagging which allows to change the behaviour based on client
-       and server headers.
+  *  Supports https inspection which allows to filter https requests.
 
-    *  Can be run as an "intercepting" proxy, which obviates the need to
-       configure browsers individually.
+  *  Can be run as an "intercepting" proxy, which obviates the need to
+     configure browsers individually.
 
-    *  Sophisticated actions and filters for manipulating both server and
-       client headers.
+  *  Sophisticated actions and filters for manipulating both server and
+     client headers.
 
-    *  Can be chained with other proxies.
+  *  Can be chained with other proxies.
 
-    *  Integrated browser based configuration and control utility at
-       http://config.privoxy.org/ (shortcut: http://p.p/). Browser-based
-       tracing of rule and filter effects. Remote toggling.
+  *  Integrated browser based configuration and control utility at
+     http://config.privoxy.org/ (shortcut: http://p.p/). Browser-based
+     tracing of rule and filter effects. Remote toggling.
 
-    *  Web page filtering (text replacements, removes banners based on size,
-       invisible <quote>web-bugs</quote> and HTML annoyances, etc.)
+  *  Web page filtering (text replacements, removes banners based on size,
+     invisible "web-bugs" and HTML annoyances, etc.)
 
-    *  Modularized configuration that allows for standard settings and user
-       settings to reside in separate files, so that installing updated actions
-       files won't overwrite individual user settings.
+  *  Modularized configuration that allows for standard settings and user
+     settings to reside in separate files, so that installing updated actions
+     files won't overwrite individual user settings.
 
-    *  Support for Perl Compatible Regular Expressions in the configuration
-       files, and a more sophisticated and flexible configuration syntax.
+  *  Support for Perl Compatible Regular Expressions in the configuration
+     files, and a more sophisticated and flexible configuration syntax.
 
-    *  GIF de-animation.
+  *  GIF de-animation.
 
-    *  Bypass many click-tracking scripts (avoids script redirection).
+  *  Bypass many click-tracking scripts (avoids script redirection).
 
-    *  User-customizable HTML templates for most proxy-generated pages (e.g.
-       "blocked" page).
+  *  User-customizable HTML templates for most proxy-generated pages (e.g.
+     "blocked" page).
 
-    *  Auto-detection and re-reading of config file changes.
-    
-    *  Most features are controllable on a per-site or per-location basis.
+  *  Auto-detection and re-reading of config file changes.
     
+  *  Most features are controllable on a per-site or per-location basis.
 
-Download location: 
-   http://sourceforge.net/project/showfiles.php?group_id=11118
-Home Page: 
-   http://www.privoxy.org/
 
+Home Page: 
+   https://www.privoxy.org/
 
-  - Privoxy Developers <ijbswa-developers@lists.sourceforge.net>
+  - Privoxy Developers <privoxy-devel@lists.privoxy.org>