Bump SMGL entities for 3.0.34 UNRELEASED
[privoxy.git] / doc / webserver / announce.txt
index 8af09f0..c56d0d1 100644 (file)
-               Announcing Privoxy 3.0.24 stable
+               Announcing Privoxy 3.0.33 stable
 --------------------------------------------------------------------
 
-Privoxy 3.0.24 stable contains a couple of new features but is
-mainly a bug-fix release. Two of the fixed bugs are security issues
-and may be used to remotely trigger crashes on platforms that
-carefully check memory accesses (most don't).
+Privoxy 3.0.33 fixes an XSS issue, multiple DoS issues and a
+couple of other bugs. The issues also affect earlier Privoxy releases.
+Privoxy 3.0.33 also comes with a couple of general improvements and
+new features.
 
 --------------------------------------------------------------------
-ChangeLog for Privoxy
+ChangeLog for Privoxy 3.0.33
 --------------------------------------------------------------------
-- Security fixes (denial of service):
-  - Prevent invalid reads in case of corrupt chunk-encoded content.
-    CVE-2016-1982. Bug discovered with afl-fuzz and AddressSanitizer.
-  - Remove empty Host headers in client requests.
-    Previously they would result in invalid reads. CVE-2016-1983.
-    Bug discovered with afl-fuzz and AddressSanitizer.
+- Security/Reliability:
+  - cgi_error_no_template(): Encode the template name to prevent
+    XSS (cross-site scripting) when Privoxy is configured to servce
+    the user-manual itself.
+    Commit 0e668e9409c. OVE-20211102-0001. CVE-2021-44543.
+    Reported by: Artem Ivanov
+  - get_url_spec_param(): Free memory of compiled pattern spec
+    before bailing.
+    Reported by Joshua Rogers (Opera) who also provided the fix.
+    Commit 652b4b7cb0. OVE-20211201-0003. CVE-2021-44540.
+  - process_encrypted_request_headers(): Free header memory when
+    failing to get the request destination.
+    Reported by Joshua Rogers (Opera) who also provided the fix.
+    Commit 0509c58045. OVE-20211201-0002. CVE-2021-44541.
+  - send_http_request(): Prevent memory leaks when handling errors
+    Reported by Joshua Rogers (Opera) who also provided the fix.
+    Commit c48d1d6d08. OVE-20211201-0001. CVE-2021-44542.
 
 - Bug fixes:
-  - 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.
-  - Fixed buffer scaling in execute_external_filter() that could lead
-    to crashes. Submitted by Yang Xia in #892.
-  - Fixed crashes when executing external filters on platforms like
-    Mac OS X. Reported by Jonathan McKenzie on ijbswa-users@.
-  - 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@.
-  - 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.
-  - 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.
-  - 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.
-  - Detect and reject parameters for parameter-less actions.
-    Previously they were silently ignored.
-  - Fixed invalid reads in internal and outdated pcre code.
-    Found with afl-fuzz and AddressSanitizer.
-  - Prevent invalid read when loading invalid action files.
-    Found with afl-fuzz and AddressSanitizer.
-  - 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.
-  - 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.
+  - 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.
+  - 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.
+  - 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.
+  - 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.
+  - load_config(): Add a space that was missing in a log message.
+  - read_http_request_body(): Fix two error messages that used an
+    incorrect variable.
+  - 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.
 
 - General improvements:
-  - 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.
-  - Allow to build with mingw x86_64. Submitted by Rustam Abdullaev in #135.
-  - 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.
-  - 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).
-  - Improved error messages when rejecting intercepted requests
-    with unknown destination.
-  - A couple of log messages now include the number of active threads.
-  - Removed non-standard Proxy-Agent headers in HTTP snipplets
-    to make testing more convenient.
-  - Include the error code for pcre errors Privoxy does not recognize.
-  - Config directives with numerical arguments are checked more carefully.
-  - Privoxy's malloc() wrapper has been changed to prevent zero-size
-    allocations which should only occur as the result of bugs.
-  - Various cosmetic changes.
+  - 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.
+  - 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.
+  - 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.
+  - 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@.
+  - 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.
+  - 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.
+  - 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.
+  - 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.
+  - handle_established_connection(): Slightly improve a comment.
+  - handle_established_connection(): Fix a comment.
+  - socks5_connect(): Fix indentation.
+  - handle_established_connection(): Improve an error message.
+  - create_pattern_spec(): Fix ifdef indentation.
+  - Fix comment typos.
+  - 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.
+  - chat(): Log the applied actions before deciding how to forward the request.
+  - parse_time_header(): Silence a coverity complaint when building without assertions.
+  - receive_encrypted_request_headers(): Improve a log message.
+  - 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.
+  - 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.
+  - 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
+  - OpenSSL generate_host_certificate(): Fix two error messsages.
+  - Improve description of handle_established_connection()
+  - OpenSSL ssl_store_cert(): Translate EVP_PKEY_EC to a string.
+  - OpenSSL ssl_store_cert(): Remove pointless variable initialization.
+  - OpenSSL ssl_store_cert(): Initialize pointer with NULL instead of 0.
 
 - Action file improvements:
-  - Unblock ".deutschlandradiokultur.de/".
-    Reported by u302320 in #924.
-  - Add two fast-redirect exceptions for "yandex.ru".
-  - Disable filter{banners-by-size} for ".plasmaservice.de/".
-  - Unblock "klikki.fi/adv/".
-  - Block requests for "resources.infolinks.com/".
-    Reported by "Black Rider" on ijbswa-users@.
-  - Block a bunch of criteo domains.
-    Reported by Black Rider.
-  - Block "abs.proxistore.com/abe/".
-    Reported by Black Rider.
-  - Disable filter{banners-by-size} for ".black-mosquito.org/".
-  - Disable fast-redirects for "disqus.com/".
-
-- Documentation improvements:
-  - 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.
-  - 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@.
-  - Fixed the documented type of the forward-override{} action
-    which is obviously 'parameterized'.
-
-- Website improvements:
-  - 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).
-  - The website is now available as onion service
-    (http://jvauzb4sb3bwlsnc.onion/).
+  - Disable fast-redirects for .microsoftonline.com/.
+  - Disable fast-redirects for idp.springer.com/.
+  - Disable fast-redirects for .zeit.de/zustimmung.
+  - Unblock adv-archiv.dfn-cert.de/.
+  - Block requests to eu-tlp01.kameleoon.eu/.
+  - Block requests to fpa-events.arstechnica.com/.
+  - Unblock nlnet.nl/.
+  - Unblock adguard.com/.
+
+- Privoxy-Log-Parser:
+  - Highlight 'Socket timeout 3 reached: http://127.0.0.1:20000/no-filter/chunked-content/36'.
+  - Improve documentation for inactivity-detection mode.
+  - Detect date changes when looking for inactivity.
+  - Add a --passed-request-statistics-threshold option
+    that can be set to get statistics for requests that
+    were passed.
+  - Add a "inactivity detection" mode which can be useful
+    for debugging purposes.
+  - Bump version to 0.9.4.
+  - Only run print_intro() and print_outro() when syntax highlighting.
+  - Rephrase a sentence in the documentation.
+  - Highlight 'Client socket 7 is no longer usable. The server socket has been closed.'.
+  - Clarify --statistics output by explicitly mentioning that
+    the status codes sent by the server may differ from the ones
+    in "debug 512" messages.
+  - Fix typo in the --statistics output.
+  - Remove an unused variable.
+  - Highlight 'The peer notified us that the connection on socket 11 is going to be closed'.
+
+- Privoxy-Regression-Test:
+  - Remove duplicated word in a comment.
+
+- regression-tests.action:
+  - Add fetch test for http://p.p/wpad.dat.
+  - Bump for-privoxy-version to 3.0.33 which introduced the wpad.dat support.
+  - Add more tests for the '/send-banner' code.
+  - Add test for OVE-20210203-0001.
+  - Add a test for CVE-2021-20217.
+
+- uagen:
+  - Bump generated Firefox version to 91 (ESR).
+  - Bump version to 1.2.3.
+  - Bump copyright.
+
+- Build system:
+  - configure: Bump SOURCE_DATE_EPOCH.
+  - GNUmakefile.in: Fix typo.
+  - 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.
+  - Add configure option to enable MemorySanitizer.
+  - Add configure option to enable UndefinedBehaviorSanitizer.
+  - Add configure option to enable AddressSanitizer.
+  - Bump copyright.
+  - 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.
+  - configure: Remove obsolete RPM_BASE check.
+
+- Windows build system:
+  - Update the build script to use mbed tls version 2.6.11.
+  - Update build script to use the final 8.45 pcre library.
+  - Put all the '--enable-xxx' options in the configure call together.
+
+- macOS build system:
+  - The OSXPackageBuilder repository has been updated and
+    can be used to create macOS packages again.
+
+- Documentation:
+  - contacting: Remove obsolete reference to announce.sgml.
+  - contacting: Request that the browser cache is cleared before
+    producing a log file for submission.
+  - Sponsor FAQ: Note that Privoxy users may follow sponsor links
+    without Referer header set.
+  - newfeatures: Clarify that https inspection also allows to
+    filter https responses.
+  - developer-manual: Mention that announce.txt should be updated
+    when doing a release.
+  - config: Explicitly mention that the CGI pages disclosing the
+    ca-password can be blocked and upgrade the disclosure paragraphs
+    to a warning.
+  - 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.
+  - Update TODO list item #184 to note that WolfSSL support will
+    (hopefully) appear after the 3.0.34 release.
+  - 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.
+  - Add a warning that the socket-timeout does not apply
+    to operations done by TLS libraries.
+  - Make documentation slightly less "offensive" for some people
+    by avoiding the word "hell".
 
 -----------------------------------------------------------------
 About Privoxy:
@@ -138,15 +239,16 @@ Privoxy is Free Software and licensed under the GNU GPLv2.
 
 Our TODO list is rather long. Helping hands and donations are welcome:
 
-  * http://www.privoxy.org/faq/general.html#PARTICIPATE
+  * https://www.privoxy.org/participate
 
-  * http://www.privoxy.org/faq/general.html#DONATE
+  * 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 etc.), GNU/Linux (RedHat, SuSE,
-Debian, Fedora, Gentoo, Slackware and others), Mac OS X (10.4 and
-upwards on PPC and Intel processors), OS/2, Haiku, DragonFly, ElectroBSD,
-FreeBSD, NetBSD, OpenBSD, Solaris, and various other flavors of Unix.
+(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
@@ -162,6 +264,8 @@ more control, more privacy and more freedom:
   *  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.
 
@@ -197,6 +301,6 @@ more control, more privacy and more freedom:
 
 
 Home Page: 
-   http://www.privoxy.org/
+   https://www.privoxy.org/
 
-  - Privoxy Developers <ijbswa-developers@lists.sourceforge.net>
+  - Privoxy Developers <privoxy-devel@lists.privoxy.org>