Update the announcement for 3.0.29 stable
[privoxy.git] / doc / webserver / announce.txt
index da79b58..fcc9e6f 100644 (file)
-              Announcing Privoxy v.3.0.20 beta
+               Announcing Privoxy 3.0.29 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.29 stable fixes a couple of memory leaks and introduces
+https inspection which allows to filter encrypted requests and
+responses.
 
 --------------------------------------------------------------------
-ChangeLog for Privoxy
+ChangeLog for Privoxy 3.0.29
 --------------------------------------------------------------------
-*** 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.
+- 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.
 
 - 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.
+  - 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.
+    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.
+
+- 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.
+
+- 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
+
 
 -----------------------------------------------------------------
 About Privoxy:
@@ -138,73 +258,69 @@ networks.
 
 Privoxy is Free Software and licensed under the GNU GPLv2.
 
-Privoxy is an associated project of Software in the Public Interest (SPI).
-
-Helping hands and donations are welcome:
+Our TODO list is rather long. Helping hands and donations are welcome:
 
-  * http://www.privoxy.org/faq/general.html#PARTICIPATE
+  * https://www.privoxy.org/faq/general.html#PARTICIPATE
 
-  * http://www.privoxy.org/faq/general.html#DONATE
+  * https://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 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>