Regenerate docs
[privoxy.git] / doc / webserver / user-manual / whatsnew.html
index aa35f55..954b9e5 100644 (file)
@@ -4,7 +4,7 @@
 <head>
   <title>What's New in this Release</title>
   <meta name="GENERATOR" content="Modular DocBook HTML Stylesheet Version 1.79">
-  <link rel="HOME" title="Privoxy 3.0.29 User Manual" href="index.html">
+  <link rel="HOME" title="Privoxy 3.0.35 User Manual" href="index.html">
   <link rel="PREVIOUS" title="Installation" href="installation.html">
   <link rel="NEXT" title="Quickstart to Using Privoxy" href="quickstart.html">
   <link rel="STYLESHEET" type="text/css" href="../p_doc.css">
@@ -15,7 +15,7 @@
   <div class="NAVHEADER">
     <table summary="Header navigation table" width="100%" border="0" cellpadding="0" cellspacing="0">
       <tr>
-        <th colspan="3" align="center">Privoxy 3.0.29 User Manual</th>
+        <th colspan="3" align="center">Privoxy 3.0.35 User Manual</th>
       </tr>
       <tr>
         <td width="10%" align="left" valign="bottom"><a href="installation.html" accesskey="P">Prev</a></td>
   </div>
   <div class="SECT1">
     <h1 class="SECT1"><a name="WHATSNEW" id="WHATSNEW">3. What's New in this Release</a></h1>
-    <p><span class="APPLICATION">Privoxy 3.0.29</span> fixes a couple of memory leaks and introduces https inspection
-    which allows to filter encrypted requests and responses.</p>
-    <p>Changes in <span class="APPLICATION">Privoxy 3.0.29</span> stable:</p>
+    <p><span class="APPLICATION">Privoxy 3.0.34</span> fixes a few minor bugs and comes with a couple of general
+    improvements and new features.</p>
+    <p>Changes in <span class="APPLICATION">Privoxy 3.0.34</span> stable:</p>
     <ul>
       <li>
-        <p>Security/Reliability:</p>
+        <p>Bug fixes:</p>
         <ul>
           <li>
-            <p>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</p>
+            <p>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.</p>
           </li>
           <li>
-            <p>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</p>
+            <p>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.</p>
           </li>
           <li>
-            <p>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</p>
+            <p>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.</p>
           </li>
           <li>
-            <p>Fixes a memory leak when client tags are active. Commit 245e1cf32. OVE-20201118-0004. Sponsored by:
-            Robert Klemme</p>
+            <p>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.</p>
           </li>
           <li>
-            <p>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.</p>
+            <p>can_filter_request_body(): Fix a log message that contained a spurious u.</p>
           </li>
           <li>
-            <p>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.</p>
+            <p>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.</p>
           </li>
           <li>
-            <p>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.</p>
+            <p>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.</p>
           </li>
           <li>
-            <p>Fixed memory leaks in the show-status CGI handler when memory allocations fail. Commit 064eac5fd0 and
-            commit fdee85c0bf3. CID 305233. OVE-20201118-0008.</p>
+            <p>socks5_connect(): Add support for target hosts specified as IPv4 address Previously the IP address was
+            sent as domain.</p>
           </li>
         </ul>
       </li>
         <p>General improvements:</p>
         <ul>
           <li>
-            <p>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.</p>
+            <p>Add a client-body-tagger action which creates tags based on the content of the request body. Sponsored
+            by: Robert Klemme.</p>
           </li>
           <li>
-            <p>pcrs: Request JIT compilation if it's supported and the filter isn't dynamic. This can speed up
-            filtering.</p>
+            <p>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.</p>
           </li>
           <li>
-            <p>Added support for Brotli decompression. Sponsored by: Robert Klemme</p>
+            <p>Add periods to a couple of log messages.</p>
           </li>
           <li>
-            <p>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</p>
+            <p>accept_connection(): Add missing space to a log message.</p>
           </li>
           <li>
-            <p>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.</p>
+            <p>Initialize ca-related defaults with strdup_or_die() so errors aren't silently ignored.</p>
           </li>
           <li>
-            <p>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</p>
+            <p>make_path: Use malloc_or_die() in cases where allocation errors were already fatal anyway.</p>
           </li>
           <li>
-            <p>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.</p>
+            <p>handle_established_connection(): Improve an error message slightly.</p>
           </li>
           <li>
-            <p>Add SOCKS5 username/password support. Based on a patch by Sam, improved by Ivan Romanov. Closes
-            Patch#141 and solves TODO#105.</p>
+            <p>receive_client_request(): Reject https URLs without CONNECT request.</p>
           </li>
           <li>
-            <p>Bump the maximum number of action and filter files to 100 each. Sponsored by: Robert Klemme</p>
+            <p>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.</p>
           </li>
           <li>
-            <p>Fixed handling of filters with "split-large-forms 1" when using the CGI editor. Reported by withoutname
-            in #921.</p>
+            <p>Add read_socks_reply() and start using it in socks5_connect() to apply the socket timeout more
+            consistently.</p>
           </li>
           <li>
-            <p>Better detect a mismatch of connection details when figuring out whether or not a connection can be
-            reused.</p>
+            <p>socks5_connect(): Deal with domain names in the socks reply</p>
           </li>
           <li>
-            <p>Don't send a "Connection failure" message instead of the "DNS failure" message. Sponsored by: Robert
-            Klemme</p>
-          </li>
-          <li>
-            <p>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.</p>
-          </li>
-          <li>
-            <p>Fixed locking around localtime() and gmtime().</p>
-          </li>
-          <li>
-            <p>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.</p>
-          </li>
-          <li>
-            <p>Remove the fallback snprintf() implementation Now that OS/2 support is gone we no longer need it.</p>
-          </li>
-          <li>
-            <p>Fixed a bunch of format specifiers log messages.</p>
-          </li>
-          <li>
-            <p>Added a missing apostrophe in the 'More Privoxy' menu.</p>
-          </li>
-          <li>
-            <p>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</p>
-          </li>
-          <li>
-            <p>Fix build without FEATURE_CONNECTION_KEEP_ALIVE. Sponsored by: Robert Klemme</p>
-          </li>
-          <li>
-            <p>Downgrade the 'Graceful termination requested' message to LOG_LEVEL_INFO as it isn't an error. Sponsored
-            by: Robert Klemme</p>
-          </li>
-          <li>
-            <p>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</p>
-          </li>
-          <li>
-            <p>Fixed a couple of cppcheck warnings.</p>
-          </li>
-          <li>
-            <p>Rename LOG_LEVEL_GPC to LOG_LEVEL_REQUEST. Only the shadow knows what "GPC" is supposed to stand
-            for.</p>
-          </li>
-          <li>
-            <p>Remove SourceForge references in copyright headers.</p>
-          </li>
-          <li>
-            <p>Upgrade a bunch of links to the homepage to https://.</p>
-          </li>
-          <li>
-            <p>Add 'no-brotli-accepted' filter which prevents the use of Brotli compression.</p>
-          </li>
-          <li>
-            <p>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.</p>
-          </li>
-          <li>
-            <p>Updated a bunch of tests that have to expect status code 403 now after r1.168/070e904afa5.</p>
-          </li>
-          <li>
-            <p>Lowercase the host name in the request line.</p>
-          </li>
-          <li>
-            <p>Only set SOURCE_DATE_EPOCH if it's not already set so distributions can overwrite it through the
-            environment.</p>
+            <p>Add a filter for bundeswehr.de that hides the cookie and privacy info banner.</p>
           </li>
         </ul>
       </li>
       <li>
-        <p>Documentation changes:</p>
+        <p>Action file improvements:</p>
         <ul>
           <li>
-            <p>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.</p>
+            <p>Disable filter{banners-by-size} for .freiheitsfoo.de/.</p>
           </li>
           <li>
-            <p>Import the GNU GPLv3 and include it the user manual.</p>
+            <p>Disable filter{banners-by-size} for freebsdfoundation.org/.</p>
           </li>
           <li>
-            <p>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</p>
+            <p>Disable fast-redirects for consent.youtube.com/.</p>
           </li>
           <li>
-            <p>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.</p>
+            <p>Block requests to ups.xplosion.de/.</p>
           </li>
           <li>
-            <p>FAQ: Remove an obsolete comment with a link to the long-gone PDF manual.</p>
+            <p>Block requests for elsa.memoinsights.com/t.</p>
           </li>
           <li>
-            <p>FAQ: Add a link to the TODO list.</p>
+            <p>Fix a typo in a test.</p>
           </li>
           <li>
-            <p>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.</p>
+            <p>Disable fast-redirects for launchpad.net/.</p>
           </li>
           <li>
-            <p>Advertise the client-tags CGI page in the user manual.</p>
+            <p>Unblock .eff.org/.</p>
           </li>
           <li>
-            <p>Stop advertising the show-version CGI page which no longer exists.</p>
+            <p>Stop unblocking .org/.*(image|banner) which appears to be too generous The example URL
+            http://www.gnu.org/graphics/gnu-head-banner.png is already unblocked due to .gnu.org being unblocked.</p>
           </li>
           <li>
-            <p>Add yet another reason why +prevent-compression may cause problems.</p>
+            <p>Unblock adfd.org/.</p>
           </li>
           <li>
-            <p>Don't claim that contributors need ssh. It's only needed for committers.</p>
+            <p>Disable filter{banners-by-link} for .eff.org/.</p>
           </li>
           <li>
-            <p>Replace obsolete CVS instructions with Git instructions.</p>
+            <p>Block requests to odb.outbrain.com/.</p>
           </li>
           <li>
-            <p>Remove an obsolete comment</p>
+            <p>Disable fast-redirects for .gandi.net/.</p>
           </li>
-        </ul>
-      </li>
-      <li>
-        <p>Config file changes:</p>
-        <ul>
           <li>
-            <p>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</p>
+            <p>Disable fast-redirects{} for .onion/.*/status/.</p>
           </li>
           <li>
-            <p>Update the 'debug 1' description.</p>
+            <p>Disable fast-redirects{} for twitter.com/.*/status/.</p>
           </li>
           <li>
-            <p>Add a missing 'client-specific-tag' directive.</p>
+            <p>Unblock pinkstinks.de/.</p>
           </li>
           <li>
-            <p>Comment out trusted-cgi-referer pointing to example.org.</p>
+            <p>Disable fast-redirects for .hagalil.com/.</p>
           </li>
         </ul>
       </li>
       <li>
-        <p>Action file improvements:</p>
+        <p>Privoxy-Log-Parser:</p>
         <ul>
           <li>
-            <p>Block requests to /(.*/)?piwik\.php</p>
-          </li>
-          <li>
-            <p>Block requests to .connectaserver.de/</p>
-          </li>
-          <li>
-            <p>Block requests to pixel.inforsea.com/</p>
-          </li>
-          <li>
-            <p>Block requests to t.vi-serve.com/</p>
-          </li>
-          <li>
-            <p>Block requests to .ioam.de/</p>
-          </li>
-          <li>
-            <p>Block requests to t.9gag.com/img.gif</p>
-          </li>
-          <li>
-            <p>Block requests to .pixel.parsely.com/ as image</p>
-          </li>
-          <li>
-            <p>Block requests to pixel.wp.com/</p>
-          </li>
-          <li>
-            <p>Disable fast-redirects for .librarything.com/</p>
-          </li>
-          <li>
-            <p>Disable fast-redirects for issue.freebsdfoundation.org/</p>
-          </li>
-          <li>
-            <p>Disable fast-redirects for .twitter.com/.*origin=http</p>
-          </li>
-          <li>
-            <p>Unblock belco24.de/</p>
-          </li>
-          <li>
-            <p>Add fast-redirects exception for .wikipedia.org/</p>
-          </li>
-          <li>
-            <p>Add fast-redirects exception for oss-fuzz.com/</p>
-          </li>
-          <li>
-            <p>Disable fast-redirects for .consensu.org/delivery/pixel\.php and block the requests as image instead</p>
-          </li>
-          <li>
-            <p>Unblock .adbinstaller.com/ Reported by lvm in #942.</p>
-          </li>
-          <li>
-            <p>Unblock .adbshell.com Reported by lvm in #942.</p>
-          </li>
-          <li>
-            <p>Unblock .tagesschau.de/</p>
-          </li>
-          <li>
-            <p>Disable fast-redirects for collector.githubapp.com/ and block requests to it as image instead</p>
-          </li>
-          <li>
-            <p>Unblock 'ada*.'</p>
-          </li>
-          <li>
-            <p>Add fast-redirects{} exception for sourcepoint.vice.com/</p>
-          </li>
-          <li>
-            <p>Unblock adaway.org/ Reported by DRS David Soft in AF#945.</p>
+            <p>Bump version to 0.9.5.</p>
           </li>
           <li>
-            <p>Change two block reasons that previously were the same. Sponsored by: Robert Klemme</p>
+            <p>Highlight more log messages.</p>
           </li>
           <li>
-            <p>Added a +delay-response{} test.</p>
-          </li>
-          <li>
-            <p>Updated the location of the development version of default.action.master.</p>
+            <p>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.</p>
           </li>
         </ul>
       </li>
       <li>
-        <p>Privoxy-Log-Parser:</p>
+        <p>uagen:</p>
         <ul>
           <li>
-            <p>Added a --keep-date option to keep the date in highlighted messages.</p>
-          </li>
-          <li>
-            <p>Highlight new log messages.</p>
-          </li>
-          <li>
-            <p>Make gather_loglevel_clf_stats() more tolerant. While at it, count all CLF messages as requests, even if
-            the request is invalid.</p>
-          </li>
-          <li>
-            <p>Only show HTTP version distribution if at least one version has been detected.</p>
-          </li>
-          <li>
-            <p>Only show crunch statistics if crunches were detected.</p>
-          </li>
-          <li>
-            <p>Warn if the request counts differ.</p>
-          </li>
-          <li>
-            <p>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.</p>
+            <p>Bump version to 1.2.4.</p>
           </li>
           <li>
-            <p>Align the client-HTTP-version distribution like other distributions</p>
+            <p>Update BROWSER_VERSION and BROWSER_REVISION to 102.0 to match the User-Agent of the current Firefox
+            ESR.</p>
           </li>
           <li>
-            <p>Bump version to 0.9.1</p>
+            <p>Explicitly document that changing the 'Gecko token' is suspicious.</p>
           </li>
           <li>
-            <p>Include status code distribution in the stats.</p>
+            <p>Consistently use a lower-case 'c' as copyright symbol.</p>
           </li>
           <li>
-            <p>Let the statistics include the size of the content Privoxy transferred excluding HTTP headers.</p>
+            <p>Bump copyright.</p>
           </li>
           <li>
-            <p>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.</p>
+            <p>Add 'aarch64' as Linux architecture.</p>
           </li>
           <li>
-            <p>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</p>
+            <p>Add OpenBSD architecture 'arm64'.</p>
           </li>
           <li>
-            <p>Properly highlight the filter results message. Previously a brace got lost.</p>
-          </li>
-          <li>
-            <p>Prefer the number of CLF lines to get the total number of requests as it works with older Privoxy
-            versions as well.</p>
+            <p>Stop using sparc64 as FreeBSD architecture. It hasn't been supported for a while now.</p>
           </li>
         </ul>
       </li>
       <li>
-        <p>Privoxy-Regression-Test:</p>
+        <p>Build system:</p>
         <ul>
           <li>
-            <p>Turn curl's globbing mode off so we can allow more characters in URLs.</p>
-          </li>
-          <li>
-            <p>Allow '[' and ']' in URLs.</p>
+            <p>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.</p>
           </li>
           <li>
-            <p>Include the action file when complaining about missing Sticky Actions.</p>
-          </li>
-          <li>
-            <p>Fix a sentence in the documentation.</p>
+            <p>configure: Fix --with-msan option. Also (probably) reported by Andrew Savchenko.</p>
           </li>
+        </ul>
+      </li>
+      <li>
+        <p>macOS build system:</p>
+        <ul>
           <li>
-            <p>Bump version to 0.7.1</p>
+            <p>Enable HTTPS inspection when building the macOS binary (using OpenSSL as TLS library).</p>
           </li>
         </ul>
       </li>
       <li>
-        <p>url-pattern-translator:</p>
+        <p>Documentation:</p>
         <ul>
           <li>
-            <p>Detect a couple of pattern prefixes case-insensitively. Sponsored by: Robert Klemme</p>
+            <p>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.</p>
+          </li>
+          <li>
+            <p>config: Fix the documented ca-directory default value. Reported by avoidr.</p>
+          </li>
+          <li>
+            <p>Rebuild developer-manual and tidy with 'HTML Tidy for FreeBSD version 5.8.0'.</p>
           </li>
           <li>
-            <p>Skip CLIENT-TAG patterns. Sponsored by: Robert Klemme</p>
+            <p>Update developer manual with new macOS packaging instructions.</p>
           </li>
           <li>
-            <p>Skip patterns that have already been converted. It should now be safe to "convert" a file multiple
-            times. Sponsored by: Robert Klemme</p>
+            <p>Note that the FreeBSD installation instructions work for ElectroBSD as well.</p>
           </li>
           <li>
-            <p>Add the new 'PCRE-HOST-PATTERN:' prefix. Sponsored by: Robert Klemme</p>
+            <p>Note that FreeBSD/ElectroBSD users can try to install Privoxy as binary package using 'pkg'.</p>
           </li>
         </ul>
       </li>