Update SGML changelog
[privoxy.git] / doc / source / changelog.sgml
index bc2d46f..c6d086e 100644 (file)
@@ -1,11 +1,9 @@
 <!--
- File        :  $Source: /cvsroot/ijbswa/current/doc/source/changelog.sgml,v $
+ File        :  doc/source/changelog.sgml
 
  Purpose     :  Entity included in other project documents.
 
- $Id: changelog.sgml,v 2.13 2015/03/29 17:22:05 fabiankeil Exp $
-
- Copyright (C) 2013 Privoxy Developers http://www.privoxy.org/
+ Copyright (C) 2013-2021 Privoxy Developers https://www.privoxy.org/
  See LICENSE.
 
  ======================================================================
   user-manual
 -->
 
-<para>
-  <application>Privoxy 3.0.24</application> stable contains a couple
-  of new features but is mainly a bug-fix release. Two of the fixed bugs
-  are security issues (CVE requests pending) and may be used to remotely
-  trigger crashes on platforms that carefully check memory accesses (most don't).
-</para>
 
 <!--
  The SGML ChangeLog can be generated with: utils/changelog2doc.pl ChangeLog
 -->
-<para>
 
+<para>
+  <application>Privoxy 3.0.33</application> fixes an XSS issue
+  and multiple DoS issues and a couple of other bugs.
+  The issues also affect earlier Privoxy releases.
+  <application>Privoxy 3.0.33</application> also comes with
+  a couple of general improvements an new features.
+</para>
+<para>
+  Changes in <application>Privoxy 3.0.33</application> stable:
+</para>
 <para>
  <itemizedlist>
   <listitem>
    <para>
-    Security fixes (denial of service):
+    Bug fixes:
     <itemizedlist>
     <listitem>
      <para>
-      Prevent invalid reads in case of corrupt chunk-encoded content.
-      Bug discovered with afl-fuzz and AddressSanitizer.
+      handle_established_connection(): Skip the poll()/select() calls
+      if TLS data is pending on the server socket. The TLS library may
+      have already consumed all the data from the server response in
+      which case poll() and select() will not detect that data is
+      available to be read.
+      Fixes SF bug #926 reported by Wen Yue.
      </para>
     </listitem>
     <listitem>
      <para>
-      Remove empty Host headers in client requests.
-      Previously they would result in invalid reads.
-      Bug discovered with afl-fuzz and AddressSanitizer.
+      continue_https_chat(): Update csp->server_connection.request_sent
+      after sending the request to make sure the latency is calculated
+      correctly. Previously https connections were not reused after
+      timeout seconds after the first request made on the connection.
+     </para>
+    </listitem>
+    <listitem>
+     <para>
+      free_pattern_spec(): Don't try to free an invalid pointer
+      when unloading an action file with a TAG pattern while
+      Privoxy has been compiled without FEATURE_PCRE_HOST_PATTERNS.
+      Closes: SF patch request #147. Patch by Maxim Antonov.
+     </para>
+    </listitem>
+    <listitem>
+     <para>
+      Establish the TLS connection with the client earlier and decide
+      how to route the request afterwards. This allows to change the
+      forwarding settings based on information from the https-inspected
+      request, for example the path.
+     </para>
+    </listitem>
+    <listitem>
+     <para>
+      Adjust build_request_line() to create a CONNECT request line when
+      https-inspecting and forwarding to a HTTP proxy.
+      Fixes SF bug #925 reported by Wen Yue.
+     </para>
+    </listitem>
+    <listitem>
+     <para>
+      load_config(): Add a space that was missing in a log message.
      </para>
      </listitem>
     </itemizedlist>
   </listitem>
   <listitem>
    <para>
-    Bug fixes:
+    General improvements:
     <itemizedlist>
     <listitem>
      <para>
-      When using socks5t, send the request body optimistically as well.
-      Previously the request body wasn't guaranteed to be sent at all
-      and the error message incorrectly blamed the server.
-      Fixes #1686 reported by Peter Müller and G4JC.
+      serve(): Close the client socket as well if the server socket
+      for an inspected connection has been closed. Privoxy currently
+      can't establish a new server connection when the client socket
+      is reused and would drop the connection in continue_https_chat()
+      anyway.
      </para>
     </listitem>
     <listitem>
      <para>
-      Fixed buffer scaling in execute_external_filter() that could lead
-      to crashes. Submitted by Yang Xia in #892.
+      Don't disable redirect checkers in redirect_url()
+      Disable them in handle_established_connection() instead.
+      Doing it in redirect_url() prevented the +redirect{} and
+      +fast-redirects{} actions from being logged with LOG_LEVEL_ACTIONS.
      </para>
     </listitem>
     <listitem>
      <para>
-      Fixed crashes when executing external filters on platforms like
-      Mac OS X. Reported by Jonathan McKenzie on ijbswa-users@
+      handle_established_connection(): Slightly improve a comment
      </para>
     </listitem>
     <listitem>
      <para>
-      Properly parse ACL directives with ports when compiled with HAVE_RFC2553.
-      Previously the port wasn't removed from the host and in case of
-      'permit-access 127.0.0.1 example.org:80' Privoxy would try (and fail)
-      to resolve "example.org:80" instead of example.org.
-      Reported by Pak Chan on ijbswa-users@.
+      handle_established_connection(): Fix a comment
      </para>
     </listitem>
     <listitem>
      <para>
-      Check requests more carefully before serving them forcefully
-      when blocks aren't enforced. Privoxy always adds the force token
-      at the beginning of the path, but would previously accept it anywhere
-      in the request line. This could result in requests being served that
-      should be blocked. For example in case of pages that were loaded with
-      force and contained JavaScript to create additionally requests that
-      embed the origin URL (thus inheriting the force prefix).
-      The bug is not considered a security issue and the fix does not make
-      it harder for remote sites to intentionally circumvent blocks if
-      Privoxy isn't configured to enforce them.
-      Fixes #1695 reported by Korda.
+      socks5_connect(): Fix indentation.
      </para>
     </listitem>
     <listitem>
      <para>
-      Normalize the request line in intercepted requests to make rewriting
-      the destination more convenient. Previously rewrites for intercepted
-      requests were expected to fail unless $hostport was being used, but
-      they failed "the wrong way" and would result in an out-of-memory
-      message (vanilla host patterns) or a crash (extended host patterns).
-      Reported by "Guybrush Threepwood" in #1694.
+      handle_established_connection(): Improve an error message
      </para>
     </listitem>
     <listitem>
      <para>
-      Enable socket lingering for the correct socket.
-      Previously it was repeatedly enabled for the listen socket
-      instead of for the accepted socket. The bug was found by
-      code inspection and did not cause any (reported) issues.
+      create_pattern_spec(): Fix ifdef indentation
      </para>
     </listitem>
     <listitem>
      <para>
-      Detect and reject parameters for parameter-less actions.
-      Previously they were silently ignored.
+      Fix comment typos
      </para>
     </listitem>
     <listitem>
      <para>
-      Fixed invalid reads in internal and outdated pcre code.
-      Found with afl-fuzz and AddressSanitizer.
+      Add a CGI handler for /wpad.dat that returns a
+      Proxy Auto-Configuration (PAC) file.
+      Among other things, it can be used to instruct clients
+      through DHCP to use Privoxy as proxy.
+      For example with the dnsmasq option:
+      dhcp-option=252,http://config.privoxy.org/wpad.dat
+      Initial patch by Richard Schneidt.
      </para>
     </listitem>
     <listitem>
      <para>
-      Prevent invalid read when loading invalid action files.
-      Found with afl-fuzz and AddressSanitizer.
+      listen_loop(): When shutting down gracefully, close listening ports
+      before waiting for the threads to exit.
+      Allows to start a second Privoxy with the same config file
+      while the first Privoxy is still running.
      </para>
     </listitem>
     <listitem>
      <para>
-      Windows build: Use the correct function to close the event handle.
-      It's unclear if this bug had a negative impact on Privoxy's behaviour.
-      Reported by Jarry Xu in #891.
+      Allow to edit the add-header action through the CGI editor by
+      generalizing the code that got added with the suppress-tag action.
+      Closes SF patch request #146. Patch by Maxim Antonov.
      </para>
     </listitem>
     <listitem>
      <para>
-      In case of invalid forward-socks5(t) directives, use the
-      correct directive name in the error messages. Previously they
-      referred to forward-socks4t failures.
-      Reported by Joel Verhagen in #889.
+      process_encrypted_request(): Improve a log message
+      The function only processes request headers and there
+      may still be unread request body data left to process.
+     </para>
+    </listitem>
+    <listitem>
+     <para>
+      read_http_request_body(): Fix two error messages that used an incorrect variable.
+     </para>
+    </listitem>
+    <listitem>
+     <para>
+      chat(): Log the applied actions before deciding how to forward the request.
+     </para>
+    </listitem>
+    <listitem>
+     <para>
+      parse_time_header(): Silence a coverity complaint when building without assertions.
+     </para>
+    </listitem>
+    <listitem>
+     <para>
+      receive_encrypted_request_headers(): Improve a log message
+     </para>
+    </listitem>
+    <listitem>
+     <para>
+      mbedTLS get_ciphersuites_from_string(): Use strlcpy() instead of strncpy().
+      Previously the terminating NUL wasn't copied which resulted
+      in a compiler warning. This didn't cause actual problems as
+      the target buffer was initialized by zalloc_or_die() so the
+      last byte of the target buffer was NUL already.
+      Actually copying the terminating NUL seems clearer, though.
+     </para>
+    </listitem>
+    <listitem>
+     <para>
+      Remove compiler warnings. "log_error(LOG_LEVEL_FATAL, ..." doesn't return
+      but apparently the compiler doesn't know that.
+      Get rid of several "this statement may fall through [-Wimplicit-fallthrough=]" warnings.
+     </para>
+    </listitem>
+    <listitem>
+     <para>
+      If the the response is chunk-encoded, ignore the Content-Length
+      header sent by the server.
+      Allows to load https://redmine.lighttpd.net/ with filtering enabled.
+     </para>
+    </listitem>
+    <listitem>
+     <para>
+      Store the PEM certificate in a dynamically allocated buffer
+      when https-inspecting. Should prevent errors like:
+      2021-03-16 22:36:19.148 7f47bbfff700 Error: X509 PEM cert len 16694 is larger than buffer len 16383
+      As a bonus it should slightly reduce the memory usage as most
+      certificates are smaller than the previously used fixed buffer.
+      Reported by: Wen Yue
+     </para>
+    </listitem>
+    <listitem>
+     <para>
+      Don't log the applied actions in process_encrypted_request()
+      Log them in continue_https_chat() instead to mirror chat().
+      Prevents the applied actions from getting logged twice
+      for the first request on an https-inspected connection.
+     </para>
+    </listitem>
+    <listitem>
+     <para>
+      OpenSSL generate_host_certificate(): Use config.privoxy.org as Common Name
+      Org and Org Unit if the real host name is too long to get accepted by OpenSSL.
+      Clients should only care about the Subject Alternative Name
+      anyway and we can continue to use the real host name for it.
+      Reported by Miles Wen on privoxy-users@.
+     </para>
+    </listitem>
+    <listitem>
+     <para>
+      OpenSSL generate_host_certificate(): Fix two error messsages.
+     </para>
+    </listitem>
+    <listitem>
+     <para>
+      Improve description of handle_established_connection()
+     </para>
+    </listitem>
+    <listitem>
+     <para>
+      OpenSSL ssl_store_cert(): Translate EVP_PKEY_EC to a string.
+     </para>
+    </listitem>
+    <listitem>
+     <para>
+      OpenSSL ssl_store_cert(): Remove pointless variable initialization.
+     </para>
+    </listitem>
+    <listitem>
+     <para>
+      OpenSSL ssl_store_cert(): Initialize pointer with NULL instead of 0.
      </para>
      </listitem>
     </itemizedlist>
   </listitem>
   <listitem>
    <para>
-    General improvements:
+    Action file improvements:
+    <itemizedlist>
+    <listitem>
+     <para>
+      Disable fast-redirects for .microsoftonline.com/.
+     </para>
+    </listitem>
+    <listitem>
+     <para>
+      Disable fast-redirects for idp.springer.com/.
+     </para>
+    </listitem>
+    <listitem>
+     <para>
+      Disable fast-redirects for .zeit.de/zustimmung
+     </para>
+    </listitem>
+    <listitem>
+     <para>
+      Unblock adv-archiv.dfn-cert.de/
+     </para>
+    </listitem>
+    <listitem>
+     <para>
+      Block requests to eu-tlp01.kameleoon.eu/
+     </para>
+    </listitem>
+    <listitem>
+     <para>
+      Block requests to fpa-events.arstechnica.com/
+     </para>
+    </listitem>
+    <listitem>
+     <para>
+      Unblock nlnet.nl/.
+     </para>
+    </listitem>
+    <listitem>
+     <para>
+      Unblock adguard.com/.
+     </para>
+     </listitem>
+    </itemizedlist>
+   </para>
+  </listitem>
+  <listitem>
+   <para>
+    Privoxy-Log-Parser:
     <itemizedlist>
     <listitem>
      <para>
-      Set NO_DELAY flag for the accepting socket. This significantly reduces
-      the latency if the operating system is not configured to set the flag
-      by default. Reported by Johan Sintorn in #894.
+      Highlight 'Socket timeout 3 reached: http://127.0.0.1:20000/no-filter/chunked-content/36'
      </para>
     </listitem>
     <listitem>
      <para>
-      Allow to build with mingw x86_64. Submitted by Rustam Abdullaev in #135.
+      Improve documentation for inactivity-detection mode
      </para>
     </listitem>
     <listitem>
      <para>
-      Introduce the new forwarding type 'forward-webserver'.
-      Currently it is only supported by the forward-override{} action and
-      there's no config directive with the same name. The forwarding type
-      is similar to 'forward', but the request line only contains the path
-      instead of the complete URL.
+      Detect date changes when looking for inactivity
      </para>
     </listitem>
     <listitem>
      <para>
-      The CGI editor no longer treats 'standard.action' special.
-      Nowadays the official "standards" are part of default.action
-      and there's no obvious reason to disallow editing them through
-      the cgi editor anyway (if the user decided that the lack of
-      authentication isn't an issue in her environment).
+      Add a --passed-request-statistics-threshold option
+      That can be set to get statistics for requests that
+      were passed.
      </para>
     </listitem>
     <listitem>
      <para>
-      Improved error messages when rejecting intercepted requests
-      with unknown destination.
+      Add a "inactivity detection" mode
+      Which can be useful for debugging purposes.
      </para>
     </listitem>
     <listitem>
      <para>
-      A couple of log messages now include the number of active threads.
+      Bump version to 0.9.4
      </para>
     </listitem>
     <listitem>
      <para>
-      Removed non-standard Proxy-Agent headers in HTTP snipplets
-      to make testing more convenient.
+      Only run print_intro() and print_outro() when syntax highlighting
      </para>
     </listitem>
     <listitem>
      <para>
-      Include the error code for pcre errors Privoxy does not recognize.
+      Rephrase a sentence in the documentation
      </para>
     </listitem>
     <listitem>
      <para>
-      Config directives with numerical arguments are checked more carefully.
+      Highlight 'Client socket 7 is no longer usable. The server socket has been closed.'
      </para>
     </listitem>
     <listitem>
      <para>
-      Privoxy's malloc() wrapper has been changed to prevent zero-size
-      allocations which should only occur as the result of bugs.
+      Clarify --statistics output
+      by explicitly mentioning that the status codes
+      sent by the server may differ from the ones in
+      "debug 512" messages.
      </para>
     </listitem>
     <listitem>
      <para>
-      Various cosmetic changes.
+      Fix typo in the --statistics output
+     </para>
+    </listitem>
+    <listitem>
+     <para>
+      Remove an unused variable
+     </para>
+    </listitem>
+    <listitem>
+     <para>
+      Highlight 'The peer notified us that the connection on socket 11 is going to be closed'
      </para>
      </listitem>
     </itemizedlist>
   </listitem>
   <listitem>
    <para>
-    Action file improvements:
+    Privoxy-Regression-Test:
     <itemizedlist>
     <listitem>
      <para>
-      Unblock ".deutschlandradiokultur.de/".
-      Reported by u302320 in #924.
+      Remove duplicated word in a comment.
+     </para>
+     </listitem>
+    </itemizedlist>
+   </para>
+  </listitem>
+  <listitem>
+   <para>
+    regression-tests.action:
+    <itemizedlist>
+    <listitem>
+     <para>
+      Add fetch test for http://p.p/wpad.dat.
+     </para>
+    </listitem>
+    <listitem>
+     <para>
+      Bump for-privoxy-version to 3.0.33 which introduced the wpad.dat support.
      </para>
     </listitem>
     <listitem>
      <para>
-      Add two fast-redirect exceptions for "yandex.ru".
+      Add more tests for the '/send-banner' code.
      </para>
     </listitem>
     <listitem>
      <para>
-      Disable filter{banners-by-size} for ".plasmaservice.de/".
+      Add test for OVE-20210203-0001.
      </para>
     </listitem>
     <listitem>
      <para>
-      Unblock klikki.fi/adv/.
+      Add a test for CVE-2021-20217.
+     </para>
+     </listitem>
+    </itemizedlist>
+   </para>
+  </listitem>
+  <listitem>
+   <para>
+    uagen:
+    <itemizedlist>
+    <listitem>
+     <para>
+      Bump generated Firefox version to 91 (ESR)
      </para>
     </listitem>
     <listitem>
      <para>
-      Block requests for "resources.infolinks.com/".
-      Reported by "Black Rider" on ijbswa-users@.
+      Bump version to 1.2.3
      </para>
     </listitem>
     <listitem>
      <para>
-      Block a bunch of criteo domains.
-      Reported by Black Rider.
+      Bump copyright
+     </para>
+     </listitem>
+    </itemizedlist>
+   </para>
+  </listitem>
+  <listitem>
+   <para>
+    Build system:
+    <itemizedlist>
+    <listitem>
+     <para>
+      configure: Bump SOURCE_DATE_EPOCH.
      </para>
     </listitem>
     <listitem>
      <para>
-      Block "abs.proxistore.com/abe/".
-      Reported by Black Rider.
+      GNUmakefile.in: Fix typo.
      </para>
     </listitem>
     <listitem>
      <para>
-      Disable filter{banners-by-size} for ".black-mosquito.org/".
+      configure: Add another warning in case --disable-pthread is used
+      while POSIX threads are available.
+      Various features don't even compile when not using threads.
      </para>
     </listitem>
     <listitem>
      <para>
-      Disable fast-redirects for "disqus.com/".
+      Add configure option to enable MemorySanitizer.
+     </para>
+    </listitem>
+    <listitem>
+     <para>
+      Add configure option to enable UndefinedBehaviorSanitizer.
+     </para>
+    </listitem>
+    <listitem>
+     <para>
+      Add configure option to enable AddressSanitizer.
+     </para>
+    </listitem>
+    <listitem>
+     <para>
+      Bump copyright
+     </para>
+    </listitem>
+    <listitem>
+     <para>
+      Add a configure option to disable pcre JIT compilation.
+      While JIT compilation makes filtering faster it can
+      cause false-positive valgrind complaints.
+      As reported by Gwyn Ciesla in SF bug 924 it also can
+      cause problems when the SELinux policy does not grant
+      Privoxy "execmem" privileges.
+     </para>
+    </listitem>
+    <listitem>
+     <para>
+      configure: Remove obsolete RPM_BASE check
      </para>
      </listitem>
     </itemizedlist>
   </listitem>
   <listitem>
    <para>
-    Documentation improvements:
+    Windows build system:
     <itemizedlist>
     <listitem>
      <para>
-      FAQ: Explicitly point fingers at ASUS as an example of a
-      company that has been reported to force malware based on
-      Privoxy upon its customers.
+      Update the build script to use mbed tls version 2.6.11.
      </para>
     </listitem>
     <listitem>
      <para>
-      Correctly document the action type for a bunch of "multi-value"
-      actions that were incorrectly documented to be "parameterized".
-      Reported by Gregory Seidman on ijbswa-users@.
+      Update build script to use the final 8.45 pcre library.
      </para>
     </listitem>
     <listitem>
      <para>
-      Fixed the documented type of the forward-override{} action
-      which is obviously 'parameterized'.
+      Put all the '--enable-xxx' options in the configure call together.
      </para>
      </listitem>
     </itemizedlist>
   </listitem>
   <listitem>
    <para>
-    Website improvements:
+    Documentation:
     <itemizedlist>
     <listitem>
      <para>
-      Users who don't trust binaries served by SourceForge
-      can get them from a mirror. Migrating away from SourceForge
-      is planned for 2016 (TODO list item #53).
+      contacting: Remove obsolete reference to announce.sgml.
+     </para>
+    </listitem>
+    <listitem>
+     <para>
+      contacting: Request that the browser cache is cleared before
+      producing a log file for submission.
+     </para>
+    </listitem>
+    <listitem>
+     <para>
+      Sponsor FAQ: Note that Privoxy users may follow sponsor links
+      without Referer header set.
+     </para>
+    </listitem>
+    <listitem>
+     <para>
+      newfeatures: Clarify that https inspection also allows to
+      filter https responses.
+     </para>
+    </listitem>
+    <listitem>
+     <para>
+      developer-manual: Mention that announce.txt should be updated
+      when doing a release.
+     </para>
+    </listitem>
+    <listitem>
+     <para>
+      config: Explicitly mention that the CGI pages disclosing the
+      ca-password can be blocked and upgrade the disclosure paragraphs
+      to a warning.
+     </para>
+    </listitem>
+    <listitem>
+     <para>
+      Put all the requested debug options in the config file.
+      Section 11.1 of the Privoxy user manual lists all the debug
+      options that should be enabled when reporting problems or requesting support.
+      Make it easier for users to do the right thing by having all those
+      options present in the config.
+     </para>
+    </listitem>
+    <listitem>
+     <para>
+      Update TODO list item #184 to note that WolfSSL support will
+      (hopefully) appear after the 3.0.34 release
+     </para>
+    </listitem>
+    <listitem>
+     <para>
+      Update max-client-connections's description.
+      On modern systems other than Windows Privoxy should
+      use poll() in which case the FD_SETSIZE value isn't
+      releveant.
+     </para>
+    </listitem>
+    <listitem>
+     <para>
+      Add a warning that the socket-timeout does not apply
+      to operations done by TLS libraries
      </para>
     </listitem>
     <listitem>
      <para>
-      The website is now available as onion service
-      (http://jvauzb4sb3bwlsnc.onion/).
+      Make documentation slightly less "offensive" for some people
+      by avoiding the word "hell".
      </para>
      </listitem>
     </itemizedlist>