Prepare the announcement text for Privoxy 3.0.34 stable
[privoxy.git] / doc / webserver / announce.txt
index fcc9e6f..35720d9 100644 (file)
-               Announcing Privoxy 3.0.29 stable
+               Announcing Privoxy 3.0.34 stable
 --------------------------------------------------------------------
 
-Privoxy 3.0.29 stable fixes a couple of memory leaks and introduces
-https inspection which allows to filter encrypted requests and
-responses.
+Privoxy 3.0.34 fixes a few minor bugs and comes with a couple of
+general improvements and new features.
 
 --------------------------------------------------------------------
-ChangeLog for Privoxy 3.0.29
+ChangeLog for Privoxy 3.0.34
 --------------------------------------------------------------------
-
-- Security/Reliability:
-  - Fixed memory leaks when a response is buffered and the buffer
-    limit is reached or Privoxy is running out of memory.
-    Commits bbd53f1010b and 4490d451f9b. OVE-20201118-0001.
-    Sponsored by: Robert Klemme
-  - Fixed a memory leak in the show-status CGI handler when
-    no action files are configured. Commit c62254a686.
-    OVE-20201118-0002.
-    Sponsored by: Robert Klemme
-  - Fixed a memory leak in the show-status CGI handler when
-    no filter files are configured. Commit 1b1370f7a8a.
-    OVE-20201118-0003.
-    Sponsored by: Robert Klemme
-  - Fixes a memory leak when client tags are active.
-    Commit 245e1cf32. OVE-20201118-0004.
-    Sponsored by: Robert Klemme
-  - Fixed a memory leak if multiple filters are executed
-    and the last one is skipped due to a pcre error.
-    Commit 5cfb7bc8fe. OVE-20201118-0005.
-  - Prevent an unlikely dereference of a NULL-pointer that
-    could result in a crash if accept-intercepted-requests
-    was enabled, Privoxy failed to get the request destination
-    from the Host header and a memory allocation failed.
-    Commit 7530132349. CID 267165. OVE-20201118-0006.
-  - Fixed memory leaks in the client-tags CGI handler when
-    client tags are configured and memory allocations fail.
-    Commit cf5640eb2a. CID 267168. OVE-20201118-0007.
-  - Fixed memory leaks in the show-status CGI handler when memory
-    allocations fail. Commit 064eac5fd0 and commit fdee85c0bf3.
-    CID 305233. OVE-20201118-0008.
+- 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:
-  - Added experimental https inspection support which allows to filter
-    https traffic. To enable it, install MbedTLS and configure with
-    --with-mbedtls, or install OpenSSL or LibreSSL and configure
-    with --with-openssl.
-    Afterwards configure the directives in section 7 of the
-    config file and enable the +https-inspection action.
-    Initial MbedTLS-based code contributed by Vaclav Svec,
-    initial OpenSSL support contributed by Maxim Antonov.
-    With help from Nedzad Hrnjica and Ho+ Ho+ Ho+.
-    Integration and improvements sponsored by Robert Klemme.
-  - pcrs: Request JIT compilation if it's supported and
-    the filter isn't dynamic. This can speed up filtering.
-  - Added support for Brotli decompression.
-    Sponsored by: Robert Klemme
-  - Added FEATURE_EXTENDED_STATISTICS to gather statistics for
-    block reasons and filter executions. To enable it, configure
-    with --enable-extended-statistics and visit
-    http://config.privoxy.org/show-status.
-    Sponsored by: Robert Klemme
-  - Use the IP_FREEBIND socket option, if defined. This allows
-    Privoxy to bind to not-yet assigned IP addresses which is
-    useful in failover environments.
-    Patch by Sam Varshavchik.
-  - Allow to use extended host patterns and vanilla host patterns
-    at the same time by prefixing extended host patterns with
-    "PCRE-HOST-PATTERN:". To enable this, configure with
-    --enable-pcre-host-patterns.
-    Sponsored by: Robert Klemme
-  - Added "Cross-origin resource sharing" (CORS) support.
-    This allows to access Privoxy's CGI interface via JavaScript from
-    another domain (white-listed with the new cors-allowed-origin directive).
-    Based on a patch by Nedzad Hrnjica.
+  - Add a client-body-tagger action which creates tags based on
+    the content of the request body.
     Sponsored by: Robert Klemme.
-  - Add SOCKS5 username/password support.
-    Based on a patch by Sam, improved by Ivan Romanov.
-    Closes Patch#141 and solves TODO#105.
-  - Bump the maximum number of action and filter files
-    to 100 each.
-    Sponsored by: Robert Klemme
-  - Fixed handling of filters with "split-large-forms 1"
-    when using the CGI editor.
-    Reported by withoutname in #921.
-  - Better detect a mismatch of connection details when
-    figuring out whether or not a connection can be reused.
-  - Don't send a "Connection failure" message instead of the
-    "DNS failure" message.
-    Sponsored by: Robert Klemme
-  - Let LOG_LEVEL_REQUEST log all requests. Previously unencrypted
-    requests were only logged with LOG_LEVEL_REQUEST when they weren't
-    crunched (in which case they were logged with LOG_LEVEL_CRUNCH).
-    This was documented behaviour, but logging all requests seems more useful.
-  - Fixed locking around localtime() and gmtime().
-  - Removed OS/2 support. We haven't provided OS/2 packages in years,
-    it complicated the code and it depended on a fallback snprintf()
-    implementation which is GPLv2 only.
-  - Remove the fallback snprintf() implementation
-    Now that OS/2 support is gone we no longer need it.
-  - Fixed a bunch of format specifiers log messages.
-  - Added a missing apostrophe in the 'More Privoxy' menu.
-  - Explicitly prevent use of FEATURE_CONNECTION_SHARING
-    without FEATURE_CONNECTION_KEEP_ALIVE. It makes no sense
-    and does not compile anyway.
-    Sponsored by: Robert Klemme
-  - Fix build without FEATURE_CONNECTION_KEEP_ALIVE.
-    Sponsored by: Robert Klemme
-  - Downgrade the 'Graceful termination requested' message
-    to LOG_LEVEL_INFO as it isn't an error.
-    Sponsored by: Robert Klemme
-  - decompress_iob(): Downgrade the no-content message to LOG_LEVEL_RE_FILTER
-    While at it, fix a typo in a comment.
-    Sponsored by: Robert Klemme
-  - Fixed a couple of cppcheck warnings.
-  - Rename LOG_LEVEL_GPC to LOG_LEVEL_REQUEST.
-    Only the shadow knows what "GPC" is supposed to stand for.
-  - Remove SourceForge references in copyright headers.
-  - Upgrade a bunch of links to the homepage to https://.
-  - Add 'no-brotli-accepted' filter which prevents the
-    use of Brotli compression.
-  - Changed license for pcrs to GPLv2+ after getting the
-    permission from Andreas. This allows to redistribute
-    Privoxy under the GPLv3 which is required when linking
-    to future mbedTLS versions which are expected to be
-    licensed under the Apache 2.0 license only.
-  - Updated a bunch of tests that have to expect status code 403
-    now after r1.168/070e904afa5.
-  - Lowercase the host name in the request line.
-  - Only set SOURCE_DATE_EPOCH if it's not already set so
-    distributions can overwrite it through the environment.
-
-- Documentation changes:
-  - Explain that Privoxy has to be distributed under the
-    GPLv3 (or later) when linked with an MbedTLS version
-    that is licensed under the Apache 2.0 license.
-  - Import the GNU GPLv3 and include it the user manual.
-  - Clarify FEATURE_FORCE_LOAD's description. It allows to bypass
-    blocking not filtering and only does it if blocks aren't enforced.
-    Reported by: Robert Klemme
-  - FAQ: Remove Zwiebelfreunde e.V. from the list of fiduciary sponsors
-    As of 2021 they no longer handle donations for foreign organisations
-    due to lack of resources.
-  - FAQ: Remove an obsolete comment with a link to the long-gone PDF manual.
-  - FAQ: Add a link to the TODO list.
-  - FAQ: Change the sponsor amounts to USD slightly rounding the
-    converted amounts up to get simple numbers.
-    Receiving USD is apparently easier for SPI and SPI is
-    preferred by sponsors as they can send invoices.
-  - Advertise the client-tags CGI page in the user manual.
-  - Stop advertising the show-version CGI page which no longer exists.
-  - Add yet another reason why +prevent-compression may cause problems.
-  - Don't claim that contributors need ssh. It's only needed for committers.
-  - Replace obsolete CVS instructions with Git instructions.
-  - Remove an obsolete comment
-
-- Config file changes:
-  - Change the suggested default-server-timeout to 5 to match the
-    suggested keep-alive-timeout. Otherwise using the defaults would
-    result in Privoxy reducing the default-server-timeout and logging
-    an error message.
-    Sponsored by: Robert Klemme
-  - Update the 'debug 1' description.
-  - Add a missing 'client-specific-tag' directive.
-  - Comment out trusted-cgi-referer pointing to example.org.
+  - 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:
-  - Block requests to /(.*/)?piwik\.php
-  - Block requests to .connectaserver.de/
-  - Block requests to pixel.inforsea.com/
-  - Block requests to t.vi-serve.com/
-  - Block requests to .ioam.de/
-  - Block requests to t.9gag.com/img.gif
-  - Block requests to .pixel.parsely.com/ as image
-  - Block requests to pixel.wp.com/
-  - Disable fast-redirects for .librarything.com/
-  - Disable fast-redirects for issue.freebsdfoundation.org/
-  - Disable fast-redirects for .twitter.com/.*origin=http
-  - Unblock belco24.de/
-  - Add fast-redirects exception for .wikipedia.org/
-  - Add fast-redirects exception for oss-fuzz.com/
-  - Disable fast-redirects for .consensu.org/delivery/pixel\.php
-    and block the requests as image instead
-  - Unblock .adbinstaller.com/
-    Reported by lvm in #942.
-  - Unblock .adbshell.com
-    Reported by lvm in #942.
-  - Unblock .tagesschau.de/
-  - Disable fast-redirects for collector.githubapp.com/
-    and block requests to it as image instead
-  - Unblock 'ada*.'
-  - Add fast-redirects{} exception for sourcepoint.vice.com/
-  - Unblock adaway.org/
-    Reported by DRS David Soft in AF#945.
-  - Change two block reasons that previously were the same.
-    Sponsored by: Robert Klemme
-  - Added a +delay-response{} test.
-  - Updated the location of the development version
-    of default.action.master.
+  - 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:
-  - Added a --keep-date option to keep the date in highlighted messages.
-  - Highlight new log messages.
-  - Make gather_loglevel_clf_stats() more tolerant. While at it,
-    count all CLF messages as requests, even if the request is invalid.
-  - Only show HTTP version distribution if at least one version has been detected.
-  - Only show crunch statistics if crunches were detected.
-  - Warn if the request counts differ.
-  - Generate statistics if the log only contains LOG_LEVEL_CLF messages
-    so it can be used with vanilla webserver logs.
-    Previously Privoxy-specific "Request:" messages were required.
-  - Align the client-HTTP-version distribution like other distributions
-  - Bump version to 0.9.1
-  - Include status code distribution in the stats.
-  - Let the statistics include the size of the content Privoxy
-    transferred excluding HTTP headers.
-  - Get with the program and expect all requests to be logged with LOG_LEVEL_REQUEST.
-    It's no longer necessary to count both LOG_LEVEL_REQUEST and
-    LOG_LEVEL_CRUNCH messages to get the total number of requests.
-  - Leverage the LOG_LEVEL_CLF message to gather statistics that where
-    previously taken from LOG_LEVEL_HEADER lines. This results in less
-    confusing results if https inspection is enabled in which case there
-    are two LOG_LEVEL_HEADER lines with request lines.
-    Sponsored by: Robert Klemme
-  - Properly highlight the filter results message. Previously a brace got lost.
-  - Prefer the number of CLF lines to get the total number of requests
-    as it works with older Privoxy versions as well.
-
-- Privoxy-Regression-Test:
-  - Turn curl's globbing mode off so we can allow more characters in URLs.
-  - Allow '[' and ']' in URLs.
-  - Include the action file when complaining about missing Sticky Actions.
-  - Fix a sentence in the documentation.
-  - Bump version to 0.7.1
-
-- url-pattern-translator:
-  - Detect a couple of pattern prefixes case-insensitively.
-    Sponsored by: Robert Klemme
-  - Skip CLIENT-TAG patterns.
-    Sponsored by: Robert Klemme
-  - Skip patterns that have already been converted.
-    It should now be safe to "convert" a file multiple times.
-    Sponsored by: Robert Klemme
-  - Add the new 'PCRE-HOST-PATTERN:' prefix.
-    Sponsored by: Robert Klemme
-
+  - 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:
@@ -260,15 +153,16 @@ Privoxy is Free Software and licensed under the GNU GPLv2.
 
 Our TODO list is rather long. Helping hands and donations are welcome:
 
-  * https://www.privoxy.org/faq/general.html#PARTICIPATE
+  * https://www.privoxy.org/participate
 
-  * https://www.privoxy.org/faq/general.html#DONATE
+  * 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 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.
+(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