Update SGML changelog
[privoxy.git] / doc / webserver / user-manual / whatsnew.html
index aa35f55..dceb2ed 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.33 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.33 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.32</span> fixes multiple DoS issues and a couple of other bugs. The issues
+    also affect earlier Privoxy releases.</p>
+    <p>Changes in <span class="APPLICATION">Privoxy 3.0.32</span> stable:</p>
     <ul>
       <li>
         <p>Security/Reliability:</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>ssplit(): Remove an assertion that could be triggered with a crafted CGI request. Commit 2256d7b4d67.
+            OVE-20210203-0001. Reported by: Joshua Rogers (Opera)</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>cgi_send_banner(): Overrule invalid image types. Prevents a crash with a crafted CGI request if Privoxy
+            is toggled off. Commit e711c505c48. OVE-20210206-0001. Reported by: Joshua Rogers (Opera)</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>socks5_connect(): Don't try to send credentials when none are configured. Fixes a crash due to a
+            NULL-pointer dereference when the socks server misbehaves. Commit 85817cc55b9. OVE-20210207-0001. Reported
+            by: Joshua Rogers (Opera)</p>
           </li>
           <li>
-            <p>Fixes a memory leak when client tags are active. Commit 245e1cf32. OVE-20201118-0004. Sponsored by:
-            Robert Klemme</p>
+            <p>chunked_body_is_complete(): Prevent an invalid read of size two. Commit a912ba7bc9c. OVE-20210205-0001.
+            Reported by: Joshua Rogers (Opera)</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>
-          </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>
-          </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>
-          </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>Obsolete pcre: Prevent invalid memory accesses with an invalid pattern passed to pcre_compile(). Note
+            that the obsolete pcre code is scheduled to be removed before the 3.0.33 release. There has been a warning
+            since 2008 already. Commit 28512e5b624. OVE-20210222-0001. Reported by: Joshua Rogers (Opera)</p>
           </li>
         </ul>
       </li>
       <li>
-        <p>General improvements:</p>
+        <p>Bug fixes:</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>
-          </li>
-          <li>
-            <p>pcrs: Request JIT compilation if it's supported and the filter isn't dynamic. This can speed up
-            filtering.</p>
-          </li>
-          <li>
-            <p>Added support for Brotli decompression. Sponsored by: Robert Klemme</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>
-          </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>
-          </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>
-          </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>
-          </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>
-          </li>
-          <li>
-            <p>Bump the maximum number of action and filter files to 100 each. Sponsored by: Robert Klemme</p>
-          </li>
-          <li>
-            <p>Fixed handling of filters with "split-large-forms 1" when using the CGI editor. Reported by withoutname
-            in #921.</p>
-          </li>
-          <li>
-            <p>Better detect a mismatch of connection details when figuring out whether or not a connection can be
-            reused.</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>
+            <p>Properly parse the client-tag-lifetime directive. Previously it was not accepted as an obsolete hash
+            value was being used. Reported by: Joshua Rogers (Opera)</p>
           </li>
           <li>
-            <p>Fixed locking around localtime() and gmtime().</p>
+            <p>decompress_iob(): Prevent reading of uninitialized data. Reported by: Joshua Rogers (Opera).</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>
+            <p>decompress_iob(): Don't advance cur past eod when looking for the end of the file name and comment.</p>
           </li>
           <li>
-            <p>Remove the fallback snprintf() implementation Now that OS/2 support is gone we no longer need it.</p>
+            <p>decompress_iob(): Cast value to unsigned char before shifting. Prevents a left-shift of a negative value
+            which is undefined behaviour. Reported by: Joshua Rogers (Opera)</p>
           </li>
           <li>
-            <p>Fixed a bunch of format specifiers log messages.</p>
+            <p>gif_deanimate(): Confirm that that we have enough data before doing any work. Fixes a crash when fuzzing
+            with an empty document. Reported by: Joshua Rogers (Opera).</p>
           </li>
           <li>
-            <p>Added a missing apostrophe in the 'More Privoxy' menu.</p>
+            <p>buf_copy(): Fail if there's no data to write or nothing to do. Prevents undefined behaviour "applying
+            zero offset to null pointer". Reported by: Joshua Rogers (Opera)</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>
+            <p>log_error(): Treat LOG_LEVEL_FATAL as fatal even when --stfu is being used while fuzzing. Reported by:
+            Joshua Rogers (Opera).</p>
           </li>
           <li>
-            <p>Fix build without FEATURE_CONNECTION_KEEP_ALIVE. Sponsored by: Robert Klemme</p>
+            <p>Respect DESTDIR when considering whether or not to install config files with ".new" extension.</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>
+            <p>OpenSSL ssl_store_cert(): Fix two error messages.</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>
+            <p>Fix a couple of format specifiers.</p>
           </li>
           <li>
-            <p>Fixed a couple of cppcheck warnings.</p>
+            <p>Silence compiler warnings when compiling with NDEBUG.</p>
           </li>
           <li>
-            <p>Rename LOG_LEVEL_GPC to LOG_LEVEL_REQUEST. Only the shadow knows what "GPC" is supposed to stand
-            for.</p>
+            <p>fuzz_server_header(): Fix compiler warning.</p>
           </li>
           <li>
-            <p>Remove SourceForge references in copyright headers.</p>
+            <p>fuzz_client_header(): Fix compiler warning.</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>cgi_send_user_manual(): Also reject requests if the user-manual directive specifies a https:// URL.
+            Previously Privoxy would try and fail to open a local file.</p>
           </li>
         </ul>
       </li>
       <li>
-        <p>Documentation changes:</p>
+        <p>General 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>
-          </li>
-          <li>
-            <p>Import the GNU GPLv3 and include it the user manual.</p>
+            <p>Log the TLS version and the the cipher when debug 2 is enabled.</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>ssl_send_certificate_error(): Respect HEAD requests by not sending a body.</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>ssl_send_certificate_error(): End the body with a single new line.</p>
           </li>
           <li>
-            <p>FAQ: Remove an obsolete comment with a link to the long-gone PDF manual.</p>
+            <p>serve(): Increase the chances that the host is logged when closing a server socket.</p>
           </li>
           <li>
-            <p>FAQ: Add a link to the TODO list.</p>
+            <p>handle_established_connection(): Add parentheses to clarify an expression Suggested by: David
+            Binderman</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>continue_https_chat(): Explicitly unset CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE if
+            process_encrypted_request() fails. This makes it more obvious that the connection will not be reused.
+            Previously serve() relied on CSP_FLAG_SERVER_CONTENT_LENGTH_SET and CSP_FLAG_CHUNKED being unset. Inspired
+            by a patch from Joshua Rogers (Opera).</p>
           </li>
           <li>
-            <p>Advertise the client-tags CGI page in the user manual.</p>
+            <p>decompress_iob(): Add periods to a couple of log messages</p>
           </li>
           <li>
-            <p>Stop advertising the show-version CGI page which no longer exists.</p>
+            <p>Terminate the body of the HTTP snipplets with a single new line instead of "\r\n".</p>
           </li>
           <li>
-            <p>Add yet another reason why +prevent-compression may cause problems.</p>
+            <p>configure: Add --with-assertions option and only enable assertions when it is used</p>
           </li>
           <li>
-            <p>Don't claim that contributors need ssh. It's only needed for committers.</p>
+            <p>windows build: Use --with-brotli and --with-mbedtls by default and enable dynamic error checking.</p>
           </li>
           <li>
-            <p>Replace obsolete CVS instructions with Git instructions.</p>
+            <p>gif_deanimate(): Confirm we've got an image before trying to write it Saves a pointless buf_copy()
+            call.</p>
           </li>
           <li>
-            <p>Remove an obsolete comment</p>
+            <p>OpenSSL ssl_store_cert(): Remove a superfluous space before the serial number.</p>
           </li>
         </ul>
       </li>
       <li>
-        <p>Config file changes:</p>
+        <p>Action file improvements:</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 .golem.de/</p>
           </li>
           <li>
-            <p>Update the 'debug 1' description.</p>
+            <p>Unblock requests to adri*.</p>
           </li>
           <li>
-            <p>Add a missing 'client-specific-tag' directive.</p>
+            <p>Block requests for trc*.taboola.com/</p>
           </li>
           <li>
-            <p>Comment out trusted-cgi-referer pointing to example.org.</p>
+            <p>Disable fast-redirects for .linkedin.com/</p>
           </li>
         </ul>
       </li>
       <li>
-        <p>Action file improvements:</p>
+        <p>Filter file improvements:</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>
-          </li>
-          <li>
-            <p>Change two block reasons that previously were the same. Sponsored by: Robert Klemme</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>Make the second pcrs job of the img-reorder filter greedy again. The ungreedy version broke the img tags
+            on: https://bulk.fefe.de/scalability/.</p>
           </li>
         </ul>
       </li>
         <p>Privoxy-Log-Parser:</p>
         <ul>
           <li>
-            <p>Added a --keep-date option to keep the date in highlighted messages.</p>
+            <p>Highlight a few more messages.</p>
           </li>
           <li>
-            <p>Highlight new log messages.</p>
+            <p>Clarify the --statistics output. The shown "Reused connections" are server connections so name them
+            appropriately.</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>
-          </li>
-          <li>
-            <p>Align the client-HTTP-version distribution like other distributions</p>
-          </li>
-          <li>
-            <p>Bump version to 0.9.1</p>
-          </li>
-          <li>
-            <p>Include status code distribution in the stats.</p>
-          </li>
-          <li>
-            <p>Let the statistics include the size of the content Privoxy transferred excluding HTTP headers.</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>
-          </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>
-          </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>Bump version to 0.9.3.</p>
           </li>
         </ul>
       </li>
         <p>Privoxy-Regression-Test:</p>
         <ul>
           <li>
-            <p>Turn curl's globbing mode off so we can allow more characters in URLs.</p>
+            <p>Add the --check-bad-ssl option to the --help output.</p>
           </li>
           <li>
-            <p>Allow '[' and ']' in URLs.</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>
-          </li>
-          <li>
-            <p>Bump version to 0.7.1</p>
+            <p>Bump version to 0.7.3.</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>
-          </li>
-          <li>
-            <p>Skip CLIENT-TAG patterns. Sponsored by: Robert Klemme</p>
+            <p>Add pushing the created tag to the release steps in the developer manual.</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>Clarify that 'debug 32768' should be used in addition to the other debug directives when reporting
+            problems.</p>
           </li>
           <li>
-            <p>Add the new 'PCRE-HOST-PATTERN:' prefix. Sponsored by: Robert Klemme</p>
+            <p>Add a 'Third-party licenses and copyrights' section to the user manual.</p>
           </li>
         </ul>
       </li>