remove leading spaces from <screen> and <programlisting> blocks
[privoxy.git] / doc / source / changelog.sgml
index 406e82a..48b759d 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.19 2016/05/27 15:24:51 fabiankeil Exp $
-
- Copyright (C) 2013-2016 Privoxy Developers https://www.privoxy.org/
+ Copyright (C) 2013-2021 Privoxy Developers https://www.privoxy.org/
  See LICENSE.
 
  ======================================================================
   user-manual
 -->
 
-<para>
-  <application>Privoxy 3.0.25</application> beta introduces client-specific
-  tags and includes a couple of minor improvements. It will be followed
-  by a stable release in the near future.
-</para>
 
 <!--
  The SGML ChangeLog can be generated with: utils/changelog2doc.pl ChangeLog
 -->
+
 <para>
+  <application>Privoxy 3.0.32</application> fixes multiple DoS issues
+  and a couple of other bugs. The issues also affect earlier Privoxy
+  releases.
+</para>
+ <para>
+  Changes in <application>Privoxy 3.0.32</application> stable:
+ </para>
+ <para>
  <itemizedlist>
   <listitem>
    <para>
-    Bug fixes:
-    <itemizedlist>
-    <listitem>
-     <para>
-      Always use the current toggle state for new requests.
-      Previously new requests on reused connections inherited
-      the toggle state from the previous request even though
-      the toggle state could have changed.
-      Reported by Robert Klemme.
-     </para>
-    </listitem>
-    <listitem>
-     <para>
-      Fixed two buffer-overflows in the (deprecated) static
-      pcre code. These bugs are not considered security issues
-      as the input is trusted.
-      Found with afl-fuzz and ASAN.
-     </para>
-     </listitem>
-    </itemizedlist>
-   </para>
-  </listitem>
-  <listitem>
-   <para>
-    General improvements:
+    Security/Reliability:
     <itemizedlist>
     <listitem>
      <para>
-      Added support for client-specific tags which allow Privoxy
-      admins to pre-define tags that are set for all requests from
-      clients that previously opted in through the CGI interface.
-      They are useful in multi-user setups where admins may
-      want to allow users to disable certain actions and filters
-      for themselves without affecting others.
-      In single-user setups they are useful to allow more fine-grained
-      toggling. For example to disable request blocking while still
-      crunching cookies, or to disable experimental filters only.
-      This is an experimental feature, the syntax and behaviour may
-      change in future versions.
-      Sponsored by Robert Klemme.
+      ssplit(): Remove an assertion that could be triggered with a
+      crafted CGI request.
+      Commit 2256d7b4d67. OVE-20210203-0001.
+      Reported by: Joshua Rogers (Opera)
      </para>
     </listitem>
     <listitem>
      <para>
-      Dynamic filters and taggers now support a $listen-address variable
-      which contains the address the request came in on.
-      For external filters the variable is called $PRIVOXY_LISTEN_ADDRESS.
-      Original patch contributed by pursievro.
+      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)
      </para>
     </listitem>
     <listitem>
      <para>
-      Add client-header-tagger 'listen-address'.
+      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)
      </para>
     </listitem>
     <listitem>
      <para>
-      Include the listen-address in the log message when logging new requests.
-      Patch contributed by pursievro.
+      chunked_body_is_complete(): Prevent an invalid read of size two.
+      Commit a912ba7bc9c. OVE-20210205-0001.
+      Reported by: Joshua Rogers (Opera)
      </para>
     </listitem>
     <listitem>
      <para>
-      Turn invalid max-client-connections values into fatal errors.
-     </para>
-    </listitem>
-    <listitem>
-     <para>
-      The show-status page now shows whether or not dates before 1970
-      and after 2038 are expected to be handled properly.
-      This is mainly useful for Privoxy-Regression-Test but could
-      also come handy when dealing with time-related support requests.
-     </para>
-    </listitem>
-    <listitem>
-     <para>
-      On Mac OS X the thread id in log messages are more likely to
-      be unique now.
-     </para>
-    </listitem>
-    <listitem>
-     <para>
-      When complaining about missing filters, the filter type is logged
-      as well.
-     </para>
-    </listitem>
-    <listitem>
-     <para>
-      A couple of harmless coverity warnings were silenced
-      (CID #161202, CID #161203, CID #161211).
+      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)
      </para>
      </listitem>
     </itemizedlist>
   </listitem>
   <listitem>
    <para>
-    Action file improvements:
+    Bug fixes:
     <itemizedlist>
     <listitem>
      <para>
-      Filtering is disabled for Range requests to let download resumption
-      and Windows updates work with the default configuration.
+      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)
      </para>
     </listitem>
     <listitem>
      <para>
-      Unblock ".ardmediathek.de/".
-      Reported by ThTomate in #932.
+      decompress_iob(): Prevent reading of uninitialized data.
+      Reported by: Joshua Rogers (Opera).
      </para>
-     </listitem>
-    </itemizedlist>
-   </para>
-  </listitem>
-  <listitem>
-   <para>
-    Documentation improvements:
-    <itemizedlist>
+    </listitem>
     <listitem>
      <para>
-      Add FAQ entry for crashes caused by memory limits.
+      decompress_iob(): Don't advance cur past eod when looking
+      for the end of the file name and comment.
      </para>
     </listitem>
     <listitem>
      <para>
-      Remove obsolete FAQ entry about a bug in PHP 4.2.3.
+      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)
      </para>
     </listitem>
     <listitem>
      <para>
-      Mention the new mailing lists were appropriate.
-      As the archives have not been migrated, continue to
-      mention the archives at SF in the contacting section
-      for now.
+      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).
      </para>
     </listitem>
     <listitem>
      <para>
-      Note that the templates should be adjusted if Privoxy is
-      running as intercepting proxy without getting all requests.
+      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)
      </para>
     </listitem>
     <listitem>
      <para>
-      A bunch of links were converted to https://.
+      log_error(): Treat LOG_LEVEL_FATAL as fatal even when --stfu is
+      being used while fuzzing.
+      Reported by: Joshua Rogers (Opera).
      </para>
     </listitem>
     <listitem>
      <para>
-      Rephrase onion service paragraph to make it more obvious
-      that Tor is involved and that the whole website (and not
-      just the homepage) is available as onion service.
+      Respect DESTDIR when considering whether or not to install
+      config files with ".new" extension.
      </para>
     </listitem>
     <listitem>
      <para>
-      Streamline the "More information" section on the homepage further
-      by additionally ditching the link to the 'See also' section
-      of the user manual. The section contains mostly links that are
-      directly reachable from the homepage already and the rest is
-      not significant enough to get a link from the homepage.
+      OpenSSL ssl_store_cert(): Fix two error messages.
      </para>
     </listitem>
     <listitem>
      <para>
-      Change the add-header{} example to set the DNT header
-      and use a complete section to make copy and pasting
-      more convenient.
-      Add a comment to make it obvious that adding the
-      header is not recommended for obvious reasons.
-      Using the DNT header as example was suggested by
-      Leo Wzukw.
+      Fix a couple of format specifiers.
      </para>
     </listitem>
     <listitem>
      <para>
-      Streamline the support-and-service template
-      Instead of linking to the various support trackers
-      (whose URLs hopefully change soon), link to the
-      contact section of the user manual to increase the
-      chances that users actually read it.
+      Silence compiler warnings when compiling with NDEBUG.
      </para>
     </listitem>
     <listitem>
      <para>
-      Add a FAQ entry for tainted sockets.
+      fuzz_server_header(): Fix compiler warning.
      </para>
     </listitem>
     <listitem>
      <para>
-      More sections in the documentation have stable URLs now.
+      fuzz_client_header(): Fix compiler warning.
      </para>
     </listitem>
     <listitem>
      <para>
-      FAQ: Explain why 'ping config.privoxy.org' is not expected
-      to reach a local Privoxy installation.
+      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.
      </para>
-    </listitem>
+     </listitem>
+    </itemizedlist>
+   </para>
+  </listitem>
+  <listitem>
+   <para>
+    General improvements:
+    <itemizedlist>
     <listitem>
      <para>
-      Note that donations done through Zwiebelfreunde e.V. currently
-      can't be checked automatically.
+      Log the TLS version and the the cipher when debug 2 is enabled.
      </para>
     </listitem>
     <listitem>
      <para>
-      Updated section regarding starting Privoxy under OS X.
+      ssl_send_certificate_error(): Respect HEAD requests by not sending a body.
      </para>
     </listitem>
     <listitem>
      <para>
-      Use dedicated start instructions for FreeBSD and ElectroBSD.
+      ssl_send_certificate_error(): End the body with a single new line.
      </para>
     </listitem>
     <listitem>
      <para>
-      Removed release instructions for AIX. They haven't been working
-      for years and unsurprisingly nobody seems to care.
+      serve(): Increase the chances that the host is logged when closing
+      a server socket.
      </para>
     </listitem>
     <listitem>
      <para>
-      Removed obsolete reference to the solaris-dist target.
+      handle_established_connection(): Add parentheses to clarify an expression
+      Suggested by: David Binderman
      </para>
     </listitem>
     <listitem>
      <para>
-      Updated the release instructions for FreeBSD.
+      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).
      </para>
     </listitem>
     <listitem>
      <para>
-      Removed unfinished release instructions for Amiga OS and HP-UX 11.
+      decompress_iob(): Add periods to a couple of log messages
      </para>
     </listitem>
     <listitem>
      <para>
-      Added a pointer to the Cygwin Time Machine for getting the last release of
-      Cygwin version 1.5 to use for building Privoxy on Windows.
+      Terminate the body of the HTTP snipplets with a single new line
+      instead of "\r\n".
      </para>
     </listitem>
     <listitem>
      <para>
-      Various typos have been fixed.
+      configure: Add --with-assertions option and only enable assertions
+      when it is used
      </para>
-     </listitem>
-    </itemizedlist>
-   </para>
-  </listitem>
-  <listitem>
-   <para>
-    Infrastructure improvements:
-    <itemizedlist>
+    </listitem>
     <listitem>
      <para>
-      The website is no longer hosted at SourceForge and
-      can be reached through https now.
+      windows build: Use --with-brotli and --with-mbedtls by default and
+      enable dynamic error checking.
      </para>
     </listitem>
     <listitem>
      <para>
-      The mailing lists at SourceForge have been deprecated,
-      you can subscribe to the new ones at: https://lists.privoxy.org/
+      gif_deanimate(): Confirm we've got an image before trying to write it
+      Saves a pointless buf_copy() call.
      </para>
     </listitem>
     <listitem>
      <para>
-      Migrating the remaining services from SourceForge is
-      work in progress (TODO list item #53).
+      OpenSSL ssl_store_cert(): Remove a superfluous space before the serial number.
      </para>
      </listitem>
     </itemizedlist>
   </listitem>
   <listitem>
    <para>
-    Build system improvements:
+    Action file improvements:
     <itemizedlist>
     <listitem>
      <para>
-      Add configure argument to optimistically redefine FD_SETSIZE
-      with the intent to change the maximum number of client
-      connections Privoxy can handle. Only works with some libcs.
-      Sponsored by Robert Klemme.
-     </para>
-    </listitem>
-    <listitem>
-     <para>
-      Let the tarball-dist target skip files in ".git".
-     </para>
-    </listitem>
-    <listitem>
-     <para>
-      Let the tarball-dist target work in cwds other than current.
-     </para>
-    </listitem>
-    <listitem>
-     <para>
-      Make the 'clean' target faster when run from a git repository.
-     </para>
-    </listitem>
-    <listitem>
-     <para>
-      Include tools in the generic distribution.
-     </para>
-    </listitem>
-    <listitem>
-     <para>
-      Let the gen-dist target work in cwds other than current.
-     </para>
-    </listitem>
-    <listitem>
-     <para>
-      Sort find output that is used for distribution tarballs
-      to get reproducible results.
+      Disable fast-redirects for .golem.de/
      </para>
     </listitem>
     <listitem>
      <para>
-      Don't add '-src' to the name of the tar ball generated by the
-      gen-dist target. The package isn't a source distribution but a
-      binary package.
-      While at it, use a variable for the name to reduce the chances
-      that the various references get out of sync and fix the gen-upload
-      target which was looking in the wrong directory.
+      Unblock requests to adri*.
      </para>
     </listitem>
     <listitem>
      <para>
-      Add regression-tests.action to the files that are distributed.
+      Block requests for trc*.taboola.com/
      </para>
     </listitem>
     <listitem>
      <para>
-      The gen-dist target which was broken since 2002 (r1.92) has been fixed.
+      Disable fast-redirects for .linkedin.com/
      </para>
-    </listitem>
+     </listitem>
+    </itemizedlist>
+   </para>
+  </listitem>
+  <listitem>
+   <para>
+    Filter file improvements:
+    <itemizedlist>
     <listitem>
      <para>
-      Remove genclspec.sh which has been obsolete since 2009.
+      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/.
      </para>
     </listitem>
+    </itemizedlist>
+   </para>
+  </listitem>
+  <listitem>
+   <para>
+    Privoxy-Log-Parser:
+    <itemizedlist>
     <listitem>
      <para>
-      Remove obsolete reference to Redhat spec file.
+      Highlight a few more messages.
      </para>
     </listitem>
     <listitem>
      <para>
-      Remove the obsolete announce target which has been commented out years ago.
+      Clarify the --statistics output. The shown "Reused connections"
+      are server connections so name them appropriately.
      </para>
     </listitem>
     <listitem>
      <para>
-      Let rsync skip files if the checksums match.
+      Bump version to 0.9.3.
      </para>
      </listitem>
     </itemizedlist>
     <itemizedlist>
     <listitem>
      <para>
-      Add a "Default level offset" directive which can be used to
-      change the default level by a given value.
-      This directive affects all tests located after it until the end
-      of the file or a another "Default level offset" directive is reached.
-      The purpose of this directive is to make it more convenient to skip
-      similar tests in a given file without having to remove or disable
-      the tests completely.
+      Add the --check-bad-ssl option to the --help output.
      </para>
     </listitem>
     <listitem>
      <para>
-      Let test level 17 depend on FEATURE_64_BIT_TIME_T
-      instead of FEATURE_PTHREAD which has no direct connection
-      to the time_t size.
+      Bump version to 0.7.3.
      </para>
-    </listitem>
+     </listitem>
+    </itemizedlist>
+   </para>
+  </listitem>
+  <listitem>
+   <para>
+    Documentation:
+    <itemizedlist>
     <listitem>
      <para>
-      Fix indentation in perldoc examples.
+      Add pushing the created tag to the release steps in the developer manual.
      </para>
     </listitem>
     <listitem>
      <para>
-      Don't overlook directives in the first line of the action file.
+      Clarify that 'debug 32768' should be used in addition to the other debug
+      directives when reporting problems.
      </para>
-    </listitem>
+     </listitem>
     <listitem>
      <para>
-      Bump version to 0.7.
+      Add a 'Third-party licenses and copyrights' section to the user manual.
      </para>
     </listitem>
-    <listitem>
-     <para>
-      Fix detection of the Privoxy version now that https://
-      is used for the website.
-     </para>
-     </listitem>
     </itemizedlist>
    </para>
   </listitem>