Bump SMGL entities for 3.0.34 UNRELEASED
[privoxy.git] / doc / webserver / announce.txt
index 9c581e2..c56d0d1 100644 (file)
-               Announcing Privoxy 3.0.22 stable
+               Announcing Privoxy 3.0.33 stable
 --------------------------------------------------------------------
 
-Privoxy 3.0.22 stable is mainly a bug-fix release, it also has a
-couple of new features, though. Note that the first two entries in
-the ChangeLog below refer to security issues.
+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
 --------------------------------------------------------------------
-*** Version 3.0.22 stable ***
+- 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:
-  - Fixed a memory leak when rejecting client connections due to
-    the socket limit being reached (CID 66382). This affected
-    Privoxy 3.0.21 when compiled with IPv6 support (on most
-    platforms this is the default).
-  - Fixed an immediate-use-after-free bug (CID 66394) and two
-    additional unconfirmed use-after-free complaints made by
-    Coverity scan (CID 66391, CID 66376).
-  - Actually show the FORCE_PREFIX value on the show-status page.
-  - Properly deal with Keep-Alive headers with timeout= parameters
-    If the timeout still can't be parsed, use the configured
-    timeout instead of preventing the client from keeping the
-    connection alive. Fixes #3615312/#870 reported by Bernard Guillot.
-  - Not using any filter files no longer results in warning messages
-    unless an action file is referencing header taggers or filters.
-    Reported by Stefan Kurtz in #3614835.
-  - Fixed a bug that prevented Privoxy from reusing some reusable
-    connections. Two bit masks with different purpose unintentionally
-    shared the same bit.
-  - A couple of additional bugs were discovered by Coverity Scan.
-    The fixes that are not expected to affect users are not explicitly
-    mentioned here, for details please have a look at the CVS logs.
+  - 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:
-  - Introduced negative tag patterns NO-REQUEST-TAG and NO-RESPONSE-TAG.
-    They apply if no matching tag is found after parsing client or
-    server headers.
-  - Add support for external filters which allow to process the
-    response body with a script or program written in any language
-    the platform supports. External filters are enabled with
-    +external-filter{} after they have been defined in one of the
-    filter files with a header line starting with "EXTERNAL-FILTER:".
-    External filter support is experimental, not compiled by default
-    and known not to work on all platforms.
-  - Add support for the 'PATCH' method as defined in RFC5789.
-  - Reject requests with unsupported Expect header values.
-    Fixes a couple of Co-Advisor tests.
-  - Normalize the HTTP-version in forwarded requests and responses.
-    This is an explicit RFC 2616 MUST and RFC 7230 mandates that
-    intermediaries send their own HTTP-version in forwarded
-    messages.
-  - Server 'Keep-Alive' headers are no longer forwarded. From a user's
-    point of view it doesn't really matter, but RFC 2616 (obsolete)
-    mandates that the header is removed and this fixes a Co-Advisor
-    complaint.
-  - Change declared template file encoding to UTF-8. The templates
-    already used a subset of UTF-8 anyway and changing the declaration
-    allows to properly display UTF-8 characters used in the action files.
-    This change may require existing action files with ISO-8859-1
-    characters that aren't valid UTF-8 to be converted to UTF-8.
-    Requested by Sam Chen in #582.
-  - Do not pass rejected keep-alive timeouts to the server. It might
-    not have caused any problems (we know of), but doing the right
-    thing shouldn't hurt either.
-  - Let log_error() use its own buffer size #define to make changing
-    the log buffer size slightly less inconvenient.
-  - Turned single-threaded into a "proper" toggle directive with arguments.
-  - CGI templates no longer enforce new windows for some links.
-  - Remove an undocumented workaround ('HOST' header removal) for
-    an Apple iTunes bug that according to #729900 got fixed in 2003.
+  - 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:
-  - The pattern 'promotions.' is no longer being blocked.
-    Reported by rakista in #3608540.
-  - Disable fast-redirects for .microsofttranslator.com/.
-  - Disable filter{banners-by-size} for .dgb-tagungszentren.de/.
-  - Add adn.speedtest.net as a site-specific unblocker.
-    Support request #3612908.
-  - Disable filter{banners-by-size} for creativecommons.org/.
-  - Block requests to data.gosquared.com/. Reported by cbug in #3613653.
-  - Unblock .conrad./newsletter/. Reported by David Bo in #3614238.
-  - Unblock .bundestag.de/.
-  - Unblock .rote-hilfe.de/.
-  - Disable fast-redirects for .facebook.com/plugins/like.php.
-  - Unblock Stackexchange popup URLs that aren't used to serve ads.
-    Reported by David Wagner in #3615179.
-  - Disable fast-redirects for creativecommons.org/.
-  - Unblock .stopwatchingus.info/.
-  - Block requests for .adcash.com/script/.
-    Reported by Tyrexionibus in #3615289.
-  - Disable HTML filters if the response was tagged as JavaScript.
-    Filtering JavaScript code with filters intended to deal with HTML
-    is usually a waste of time and, more importantly, may break stuff.
-  - Use a custom redirect{} for .washingtonpost.com/wp-apps/imrs\.php\?src=
-    Previously enabling the 'Advanced' settings (or manually enabling
-    +fast-redirects{}) prevented some images from being loaded properly.
-  - Unblock "adina*." Fixes #919 reported by Morton A. Goldberg.
-  - Block '/.*DigiAd'.
-  - Unblock 'adele*.'. Reported by Adele Lime in #1663.
-  - Disable banners-by-size for kggp.de/.
-
-- Filter file improvements & bug fixes:
-  - Decrease the chances that js-annoyances creates invalid JavaScript.
-    Submitted by John McGowan on ijbswa-users@.
-  - Let the msn filter hide 'related' ads again.
-  - Remove a stray '1' in the 'html-annoyances' filter.
-  - Prevent img-reorder from messing up img tags with empty src
-    attributes. Fixes #880 reported by Duncan.
-
-- Documentation improvements:
-  - Updated the 'Would you like to donate?' section.
-  - Note that invalid forward-override{} parameter syntax isn't
-    detected until the parameter is used.
-  - Add another +redirect{} example: a shortcut for illumos bugs.
-  - Make it more obvious that many operating systems support log
-    rotation out of the box.
-  - Fixed dead links. Reported by Mark Nelson in #3614557.
-  - Rephrased the 'Why is the configuration so complicated?' answer
-    to be slightly less condescending. Anonymously suggested in #3615122.
-  - Be more explicit about accept-intercepted-requests's lack of MITM support.
-  - Make 'demoronizer' FAQ entries more generic.
-  - Add an example hostname to the --pre-chroot-nslookup description.
-  - Add an example for a host pattern that matches an IP address.
-  - Rename the 'domain pattern' to 'host pattern' as it may
-    contain IP addresses as well.
-  - Recommend forward-socks5t when using Tor. It seems to work fine and
-    modifying the Tor configuration to profit from it hasn't been necessary
-    for a while now.
-  - Add another redirect{} example to stress that redirect loops can
-    and should be avoided.
-  - The usual spelling and grammar fixes. Parts of them were
-    reported by Reuben Thomas in #3615276.
-  - Mention the PCRS option letters T and D in the filter section.
-  - Clarify that handle-as-empty-doc-returns-ok is still useful
-    and will not be removed without replacement.
-  - Note that security issues shouldn't be reported using the bug tracker.
-  - Clarify what Privoxy does if both +block{} and +redirect{} apply.
-  - Removed the obsolete bookmarklets section.
-
-- Build system improvements:
-  - Let --with-group properly deal with secondary groups.
-    Patch submitted by Anatoly Arzhnikov in #3615187.
-  - Fix web-actions target.
-  - Add a web-faq target that only updates the FAQ on the webserver.
-  - Remove already-commented-out non-portable DOSFILTER alternatives.
-  - Remove the obsolete targets dok-put and dok-get.
-  - Add a sf-shell target.
-
-- Known bugs:
-  - To compile with --disable-force you need the following change which
-    didn't make it into the release:
-    http://ijbswa.cvs.sourceforge.net/viewvc/ijbswa/current/project.h?r1=1.208&r2=1.209&view=patch
-    Thanks to Kai Raven for the report.
+  - 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:
@@ -169,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,
-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
@@ -193,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.
 
@@ -206,7 +279,7 @@ more control, more privacy and more freedom:
      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.)
+     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
@@ -227,10 +300,7 @@ more control, more privacy and more freedom:
   *  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/
+   https://www.privoxy.org/
 
-  - Privoxy Developers <ijbswa-developers@lists.sourceforge.net>
+  - Privoxy Developers <privoxy-devel@lists.privoxy.org>