Update the announcement for Privoxy 3.0.32 stable
[privoxy.git] / doc / webserver / announce.txt
index d775a83..c6a27e3 100644 (file)
-              Announcing Privoxy v.3.0.14 beta
------------------------------------------------------------------
-
-Privoxy 3.0.14 beta is a bugfix-release for the previous beta
-which introduced IPv6 support, improved keep-alive support and
-a bunch of minor improvements.
+               Announcing Privoxy 3.0.32 stable
+--------------------------------------------------------------------
 
-See http://www.privoxy.org/3.0.14/user-manual/whatsnew.html for details.
+Privoxy 3.0.32 fixes multiple DoS issues and a couple of other bugs.
+The issues also affect earlier Privoxy releases.
 
 --------------------------------------------------------------------
-ChangeLog for Privoxy
+ChangeLog for Privoxy 3.0.32
 --------------------------------------------------------------------
-*** Version 3.0.14 beta ***
-
-- The latency is taken into account when evaluating whether or not to
-  reuse a connection. This should significantly reduce the number of
-  connections problems several users reported.
-- If the server doesn't specify how long the connection stays alive,
-  Privoxy errs on the safe side of caution and assumes it's only a second.
-- The error pages for connection timeouts or missing server data use a
-  Last-Modified date in the past. Retry attempts are detected and Privoxy
-  removes the If-Modified-Since header to prevent the server from responding
-  with status code 304 in which case the client would reuse the error message.
-- Setting keep-alive-timeout to 0 disables keep-alive support. Previously
-  Privoxy would claim to allow persistence but not reuse the connection.
-- Pipelined requests are less likely to be mistaken for the request
-  body of the previous request. Note that Privoxy still has no real
-  pipeline support and will either serialize pipelined requests or
-  drop them in which case the client has to resent them.
-- Fixed a crash on some Windows versions when header randomization
-  is enabled and the date couldn't be parsed.
-- Privoxy's keep-alive timeout for the current connection is reduced
-  to the one specified in the client's Keep-Alive header.
-- For HTTP/1.1 requests, Privoxy implies keep-alive support by not
-  setting any Connection header instead of using 'Connection: keep-alive'.
-- If the socket isn't reusable, Privoxy doesn't temporarily waste
-  a socket slot to remember the connection.
-- If keep-alive support is disabled but compiled in, the client's
-  Keep-Alive header is removed.
-- Fixed a bug on mingw32 where downloading large files failed if
-  keep-alive support was enabled.
-- Fixed a bug that (at least theoretically) could cause log
-  timestamps to be occasionally off by about a second.
-- No Proxy-Connection header if added if there already is one.
-- The configure script respects the $PATH variable when searching
-  for groups and id.
-
-*** Version 3.0.13 beta  ***
-
-- Added IPv6 support. Thanks to Petr Pisar who not only provided
-  the initial patch but also helped a lot with the integration.
-- Added client-side keep-alive support.
-- The connection sharing code is only used if the connection-sharing
-  option is enabled.
-- The max-client-connections option has been added to restrict
-  the number of client connections below a value enforced by
-  the operating system.
-- Fixed a regression reintroduced in 3.0.12 that could cause
-  crashes on mingw32 if header date randomization was enabled.
-- Compressed content with extra fields couldn't be decompressed
-  and would get passed to the client unfiltered. This problem
-  has only be detected through statical analysis with clang as
-  nobody seems to be using extra fields anyway.
-- If the server resets the Connection after sending only the headers
-  Privoxy forwards what it got to the client. Previously Privoxy
-  would deliver an error message instead.
-- Error messages in case of connection timeouts use the right
-  HTTP status code.
-- If spawning a child to handle a request fails, the client
-  gets an error message and Privoxy continues to listen for
-  new requests right away.
-- The error messages in case of server-connection timeouts or
-  prematurely closed server connections are now template-based.
-- If zlib support isn't compiled in, Privoxy no longer tries to
-  filter compressed content unless explicitly asked to do so.
-- In case of connections that are denied based on ACL directives,
-  the memory used for the client IP is no longer leaked.
-- Fixed another small memory leak if the client request times out
-  while waiting for client headers other than the request line.
-- The client socket is kept open until the server socket has
-  been marked as unused. This should increase the chances that
-  the still-open connection will be reused for the client's next
-  request to the same destination. Note that this only matters
-  if connection-sharing is enabled.
-- A TODO list has been added to the source tarballs to give potential
-  volunteers a better idea of what the current goals are.
+- Security/Reliability:
+  - ssplit(): Remove an assertion that could be triggered with a
+    crafted CGI request.
+    Commit 2256d7b4d67. OVE-20210203-0001.
+    Reported by: Joshua Rogers (Opera)
+  - 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)
+  - 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)
+  - chunked_body_is_complete(): Prevent an invalid read of size two.
+    Commit a912ba7bc9c. OVE-20210205-0001.
+    Reported by: Joshua Rogers (Opera)
+  - 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 since 2008 already.
+    Commit 28512e5b624. OVE-20210222-0001.
+    Reported by: Joshua Rogers (Opera)
+
+- Bug fixes:
+  - 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)
+  - decompress_iob(): Prevent reading of uninitialized data.
+    Reported by: Joshua Rogers (Opera).
+  - decompress_iob(): Don't advance cur past eod when looking
+    for the end of the file name and comment.
+  - 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)
+  - 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).
+  - 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)
+  - log_error(): Treat LOG_LEVEL_FATAL as fatal even when --stfu is
+    being used while fuzzing.
+    Reported by: Joshua Rogers (Opera).
+  - Respect DESTDIR when considering whether or not to install
+    config files with ".new" extension.
+  - OpenSSL ssl_store_cert(): Fix two error messages.
+  - Fix a couple of format specifiers.
+  - Silence compiler warnings when compiling with NDEBUG.
+  - fuzz_server_header(): Fix compiler warning.
+  - fuzz_client_header(): Fix compiler warning.
+  - 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.
+
+- General improvements:
+  - Log the TLS version and the the cipher when debug 2 is enabled..
+  - ssl_send_certificate_error(): Respect HEAD requests by not sending a body.
+  - ssl_send_certificate_error(): End the body with a single new line.
+  - serve(): Increase the chances that the host is logged when closing
+    a server socket.
+  - handle_established_connection(): Add parentheses to clarify an expression
+    Suggested by: David Binderman
+  - 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).
+  - decompress_iob(): Add periods to a couple of log messages
+  - Terminate the body of the HTTP snipplets with a single new line
+    instead of "\r\n".
+  - configure: Add --with-assertions option and only enable assertions
+    when it is used
+  - windows build: Use --with-brotli and --with-mbedtls by default and
+    enable dynamic error checking.
+  - gif_deanimate(): Confirm we've got an image before trying to write it
+    Saves a pointless buf_copy() call.
+  - OpenSSL ssl_store_cert(): Remove a superfluous space before the serial number.
+
+- Action file improvements:
+  - Disable fast-redirects for .golem.de/
+  - Unblock requests to adri*.
+  - Block requests for trc*.taboola.com/
+  - Disable fast-redirects for .linkedin.com/
+
+- Filter file improvements:
+  - 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/.
+
+- Privoxy-Log-Parser:
+  - Highlight a few more messages.
+  - Clarify the --statistics output. The shown "Reused connections"
+    are server connections so name them appropriately.
+  - Bump version to 0.9.3.
+
+- Privoxy-Regression-Test:
+  - Add the --check-bad-ssl option to the --help output.
+  - Bump version to 0.7.3.
+
+- Documentation:
+  - Add pushing the created tag to the release steps in the developer manual.
+  - Clarify that 'debug 32768' should be used in addition to the other debug
+    directives when reporting problems.
+  - Add a 'Third-party licenses and copyrights' section to the user manual.
 
 -----------------------------------------------------------------
 About Privoxy:
@@ -96,70 +124,72 @@ flexible configuration and can be customized to suit individual needs and
 tastes. It has application for both stand-alone systems and multi-user
 networks.
 
-Privoxy is Free Software and licensed under the GPL2.
+Privoxy is Free Software and licensed under the GNU GPLv2.
+
+Our TODO list is rather long. Helping hands and donations are welcome:
 
-Privoxy is an associated project of Software in the Public Interest (SPI).
-Donations are welcome: http://www.privoxy.org/faq/general.html#DONATE
+  * https://www.privoxy.org/participate
 
-At present, Privoxy is known to run on Windows(95, 98, ME, 2000,
-XP, Vista), Linux (Ubuntu, RedHat, SuSE, Debian, Fedora, Gentoo and
-others), Mac OSX, OS/2, AmigaOS, FreeBSD, NetBSD, OpenBSD, Solaris, and
-various other flavors of Unix.
+  * https://www.privoxy.org/donate
+
+At present, Privoxy is known to run on Windows 95 and later versions
+(98, ME, 2000, XP, Vista, Windows 7, Windows 10 etc.), GNU/Linux
+(RedHat, SuSE, Debian, Fedora, Gentoo, Slackware and others),
+Mac OS X (10.4 and upwards on PPC and Intel processors), Haiku,
+DragonFly, ElectroBSD, FreeBSD, NetBSD, OpenBSD, Solaris,
+and various other flavors of Unix.
 
 In addition to the core features of ad blocking and cookie management,
 Privoxy provides many supplemental features, that give the end-user
 more control, more privacy and more freedom:
 
+  *  Supports "Connection: keep-alive". Outgoing connections can be kept
+     alive independently from the client. Currently not available on all
+     platforms.
 
-    *  Supports "Connection: keep-alive". Outgoing connections can be kept
-       alive independently from the client. Currently not available on all
-       platforms.
+  *  Supports IPv6, provided the operating system does so too,
+     and the configure script detects it.
 
-    *  Supports IPv6, provided the operating system does so too,
-       and the configure script detects it.
+  *  Supports tagging which allows to change the behaviour based on client
+     and server headers.
 
-    *  Supports tagging which allows to change the behaviour based on client
-       and server headers.
+  *  Supports https inspection which allows to filter https requests.
 
-    *  Can be run as an "intercepting" proxy, which obviates the need to
-       configure browsers individually.
+  *  Can be run as an "intercepting" proxy, which obviates the need to
+     configure browsers individually.
 
-    *  Sophisticated actions and filters for manipulating both server and
-       client headers.
+  *  Sophisticated actions and filters for manipulating both server and
+     client headers.
 
-    *  Can be chained with other proxies.
+  *  Can be chained with other proxies.
 
-    *  Integrated browser based configuration and control utility at
-       http://config.privoxy.org/ (shortcut: http://p.p/). Browser-based
-       tracing of rule and filter effects. Remote toggling.
+  *  Integrated browser based configuration and control utility at
+     http://config.privoxy.org/ (shortcut: http://p.p/). Browser-based
+     tracing of rule and filter effects. Remote toggling.
 
-    *  Web page filtering (text replacements, removes banners based on size,
-       invisible <quote>web-bugs</quote> and HTML annoyances, etc.)
+  *  Web page filtering (text replacements, removes banners based on size,
+     invisible "web-bugs" and HTML annoyances, etc.)
 
-    *  Modularized configuration that allows for standard settings and user
-       settings to reside in separate files, so that installing updated actions
-       files won't overwrite individual user settings.
+  *  Modularized configuration that allows for standard settings and user
+     settings to reside in separate files, so that installing updated actions
+     files won't overwrite individual user settings.
 
-    *  Support for Perl Compatible Regular Expressions in the configuration
-       files, and a more sophisticated and flexible configuration syntax.
+  *  Support for Perl Compatible Regular Expressions in the configuration
+     files, and a more sophisticated and flexible configuration syntax.
 
-    *  GIF de-animation.
+  *  GIF de-animation.
 
-    *  Bypass many click-tracking scripts (avoids script redirection).
+  *  Bypass many click-tracking scripts (avoids script redirection).
 
-    *  User-customizable HTML templates for most proxy-generated pages (e.g.
-       "blocked" page).
+  *  User-customizable HTML templates for most proxy-generated pages (e.g.
+     "blocked" page).
 
-    *  Auto-detection and re-reading of config file changes.
-    
-    *  Most features are controllable on a per-site or per-location basis.
+  *  Auto-detection and re-reading of config file changes.
     
+  *  Most features are controllable on a per-site or per-location basis.
 
-Download location: 
-   http://sourceforge.net/project/showfiles.php?group_id=11118
-Home Page: 
-   http://www.privoxy.org/
 
+Home Page: 
+   https://www.privoxy.org/
 
-  - Privoxy Developers <ijbswa-developers@lists.sourceforge.net>
+  - Privoxy Developers <privoxy-devel@lists.privoxy.org>