Prepare the announcement text for Privoxy 3.0.34 stable
[privoxy.git] / doc / webserver / announce.txt
index da79b58..35720d9 100644 (file)
-              Announcing Privoxy v.3.0.20 beta
+               Announcing Privoxy 3.0.34 stable
 --------------------------------------------------------------------
 
-This is a beta release that introduces some new features and fixes a number of bugs, some of which are reasonably significant. One new feature (tolerate-pipelining) is enabled by default. See below 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.20 Beta ***
-
-- Bug fixes:
-  - Client sockets are now properly shutdown and drained before being
-    closed. This fixes page truncation issues with clients that aggressively
-    pipeline data on platforms that otherwise discard already written data.
-    The issue mainly affected Opera users and was initially reported
-    by Kevin in #3464439, szotsaki provided additional information to track
-    down the cause.
-  - Fix latency calculation for shared connections (disabled by default).
-    It was broken since their introduction in 2009. The calculated latency
-    for most connections would be 0 in which case the timeout detection
-    failed to account for the real latency.
-  - Reject URLs with invalid port. Previously they were parsed incorrectly and
-    characters between the port number and the first slash were silently
-    dropped as shown by curl test 187.
-  - The default-server-timeout and socket-timeout directives accept 0 as
-    valid value.
-  - Fix a race condition on Windows that could cause Privoxy to become
-    unresponsive after toggling it on or off through the taskbar icon.
-    Reported by Tim H. in #3525694.
-  - Fix the compilation on Windows when configured without IPv6 support.
-  - Fix an assertion that could cause debug builds to abort() in case of
-    socks5 connection failures with "debug 2" enabled.
-  - Fix an assertion that could cause debug builds to abort() if a filter
-    contained nul bytes in the replacement text.
-
-- General improvements:
-  - Significantly improved keep-alive support for both client and server
-    connections.
-  - New debug log level 65536 which logs all actions that were applied to
-    the request.
-  - New directive client-header-order to forward client headers in a
-    different order than the one in which they arrived.
-  - New directive tolerate-pipelining to allow client-side pipelining.
-    If enabled (3.0.20 beta enables it by default), Privoxy will keep
-    pipelined client requests around to deal with them once the current
-    request has been served.
-  - New --config-test option to let Privoxy exit after checking whether or not
-    the configuration seems valid. The limitations noted in TODO #22 and #23
-    still apply. Based on a patch by Ramkumar Chinchani.
-  - New limit-cookie-lifetime{} action to let cookies expire before the end
-    of the session. Suggested by Rick Sykes in #1049575.
-  - Increase the hard-coded maximum number of actions and filter files from
-    10 to 30 (each). It doesn't significantly affect Privoxy's memory usage
-    and recompiling wasn't an option for all Privoxy users that reached the
-    limit.
-  - Add support for chunk-encoded client request bodies. Previously
-    chunk-encoded request bodies weren't guaranteed to be forwarded correctly,
-    so this can also be considered a bug fix although chunk-encoded request
-    bodies aren't commonly used in the real world.
-  - Add support for Tor's optimistic-data SOCKS extension, which can reduce the
-    latency for requests on newly created connections. Currently only the
-    headers are sent optimistically and only if the client request has already
-    been read completely which rules out requests with large bodies.
-  - After preventing the client from pipelining, don't signal keep-alive
-    intentions. When looking at the response headers alone, it previously
-    wasn't obvious from the client's perspective that no additional responses
-    should be expected.
-  - Stop considering client sockets tainted after receving a request with body.
-    It hasn't been necessary for a while now and unnecessarily causes test
-    failures when using curl's test suite.
-  - Allow HTTP/1.0 clients to signal interest in keep-alive through the
-    Proxy-Connection header. While such client are rare in the real world, it
-    doesn't hurt and couple of curl tests rely on it.
-  - Only remove duplicated Content-Type headers when filters are enabled.
-    If they are not it doesn't cause ill effects and the user might not want it.
-    Downgrade the removal message to LOG_LEVEL_HEADER to clarify that it's not
-    an error in Privoxy and is unlikely to cause any problems in general.
-    Anonymously reported in #3599335.
-  - Set the socket option SO_LINGER for the client socket.
-  - Move several variable declarations to the beginning of their code block.
-    It's required when compiling with gcc 2.95 which is still used on some
-    platforms. Initial patch submitted by Simon South in #3564815.
-  - Optionally try to sanity-check strptime() results before trusting them.
-    Broken strptime() implementations have caused problems in the past and
-    the most recent offender seems to be FreeBSD's libc (standards/173421).
-  - When filtering is enabled, let Range headers pass if the range starts at
-    the beginning. This should work around (or at least reduce ) the video
-    playback issues with various Apple clients as reported by Duc in #3426305.
-  - Do not confuse a client hanging up with a connection time out. If a client
-    closes its side of the connection without sending a request line, do not
-    send the CLIENT_CONNECTION_TIMEOUT_RESPONSE, but report the condition
-    properly.
-  - Allow closing curly braces as part of action values as long as they are
-    escaped.
-  - On Windows, the logfile is now written before showing the GUI error
-    message which blocks until the user acknowledges it.
-    Reported by Adriaan in #3593603.
-  - Remove an unreasonable parameter limit in the CGI interface. The new
-    parameter limit depends on the memory available and is currently unlikely
-    to be reachable, due to other limits in both Privoxy and common clients.
-    Reported by Andrew on ijbswa-users@.
-  - Decrease the chances of parse failures after requests with unsupported
-    methods were sent to the CGI interface.
-
-*** Version 3.0.19 Stable ***
-
 - Bug fixes:
-  - Prevent a segmentation fault when de-chunking buffered content.
-    It could be triggered by malicious web servers if Privoxy was
-    configured to filter the content and running on a platform
-    where SIZE_T_MAX isn't larger than UINT_MAX, which probably
-    includes most 32-bit systems. On those platforms, all Privoxy
-    versions before 3.0.19 appear to be affected.
-    To be on the safe side, this bug should be presumed to allow
-    code execution as proving that it doesn't seems unrealistic.
-  - Do not expect a response from the SOCKS4/4A server until it
-    got something to respond to. This regression was introduced
-    in 3.0.18 and prevented the SOCKS4/4A negotiation from working.
-    Reported by qqqqqw in #3459781.
+  - 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:
-  - Fix an off-by-one in an error message about connect failures.
-  - Use a GNUMakefile variable for the webserver root directory and
-    update the path. Sourceforge changed it which broke various
-    web-related targets.
-  - Update the CODE_STATUS description.
+  - 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:
@@ -138,73 +151,70 @@ networks.
 
 Privoxy is Free Software and licensed under the GNU GPLv2.
 
-Privoxy is an associated project of Software in the Public Interest (SPI).
+Our TODO list is rather long. Helping hands and donations are welcome:
 
-Helping hands and donations are welcome:
+  * https://www.privoxy.org/participate
 
-  * http://www.privoxy.org/faq/general.html#PARTICIPATE
+  * https://www.privoxy.org/donate
 
-  * http://www.privoxy.org/faq/general.html#DONATE
-
-At present, Privoxy is known to run on Windows(95, 98, ME, 2000,
-XP, Vista), GNU/Linux (Ubuntu, RedHat, SuSE, Debian, Fedora, Gentoo and
-others), Mac OSX, OS/2, AmigaOS, FreeBSD, NetBSD, OpenBSD, Solaris, and
-various other flavors of Unix.
+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>