Rebuild developer-manual and tidy with 'HTML Tidy for FreeBSD version 5.8.0'
[privoxy.git] / doc / webserver / announce.txt
index fcc9e6f..c56d0d1 100644 (file)
-               Announcing Privoxy 3.0.29 stable
+               Announcing Privoxy 3.0.33 stable
 --------------------------------------------------------------------
 
-Privoxy 3.0.29 stable fixes a couple of memory leaks and introduces
-https inspection which allows to filter encrypted requests and
-responses.
+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 3.0.29
+ChangeLog for Privoxy 3.0.33
 --------------------------------------------------------------------
-
 - Security/Reliability:
-  - Fixed memory leaks when a response is buffered and the buffer
-    limit is reached or Privoxy is running out of memory.
-    Commits bbd53f1010b and 4490d451f9b. OVE-20201118-0001.
-    Sponsored by: Robert Klemme
-  - Fixed a memory leak in the show-status CGI handler when
-    no action files are configured. Commit c62254a686.
-    OVE-20201118-0002.
-    Sponsored by: Robert Klemme
-  - Fixed a memory leak in the show-status CGI handler when
-    no filter files are configured. Commit 1b1370f7a8a.
-    OVE-20201118-0003.
-    Sponsored by: Robert Klemme
-  - Fixes a memory leak when client tags are active.
-    Commit 245e1cf32. OVE-20201118-0004.
-    Sponsored by: Robert Klemme
-  - Fixed a memory leak if multiple filters are executed
-    and the last one is skipped due to a pcre error.
-    Commit 5cfb7bc8fe. OVE-20201118-0005.
-  - Prevent an unlikely dereference of a NULL-pointer that
-    could result in a crash if accept-intercepted-requests
-    was enabled, Privoxy failed to get the request destination
-    from the Host header and a memory allocation failed.
-    Commit 7530132349. CID 267165. OVE-20201118-0006.
-  - Fixed memory leaks in the client-tags CGI handler when
-    client tags are configured and memory allocations fail.
-    Commit cf5640eb2a. CID 267168. OVE-20201118-0007.
-  - Fixed memory leaks in the show-status CGI handler when memory
-    allocations fail. Commit 064eac5fd0 and commit fdee85c0bf3.
-    CID 305233. OVE-20201118-0008.
+  - 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:
+  - 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:
-  - Added experimental https inspection support which allows to filter
-    https traffic. To enable it, install MbedTLS and configure with
-    --with-mbedtls, or install OpenSSL or LibreSSL and configure
-    with --with-openssl.
-    Afterwards configure the directives in section 7 of the
-    config file and enable the +https-inspection action.
-    Initial MbedTLS-based code contributed by Vaclav Svec,
-    initial OpenSSL support contributed by Maxim Antonov.
-    With help from Nedzad Hrnjica and Ho+ Ho+ Ho+.
-    Integration and improvements sponsored by Robert Klemme.
-  - pcrs: Request JIT compilation if it's supported and
-    the filter isn't dynamic. This can speed up filtering.
-  - Added support for Brotli decompression.
-    Sponsored by: Robert Klemme
-  - Added FEATURE_EXTENDED_STATISTICS to gather statistics for
-    block reasons and filter executions. To enable it, configure
-    with --enable-extended-statistics and visit
-    http://config.privoxy.org/show-status.
-    Sponsored by: Robert Klemme
-  - Use the IP_FREEBIND socket option, if defined. This allows
-    Privoxy to bind to not-yet assigned IP addresses which is
-    useful in failover environments.
-    Patch by Sam Varshavchik.
-  - Allow to use extended host patterns and vanilla host patterns
-    at the same time by prefixing extended host patterns with
-    "PCRE-HOST-PATTERN:". To enable this, configure with
-    --enable-pcre-host-patterns.
-    Sponsored by: Robert Klemme
-  - Added "Cross-origin resource sharing" (CORS) support.
-    This allows to access Privoxy's CGI interface via JavaScript from
-    another domain (white-listed with the new cors-allowed-origin directive).
-    Based on a patch by Nedzad Hrnjica.
-    Sponsored by: Robert Klemme.
-  - Add SOCKS5 username/password support.
-    Based on a patch by Sam, improved by Ivan Romanov.
-    Closes Patch#141 and solves TODO#105.
-  - Bump the maximum number of action and filter files
-    to 100 each.
-    Sponsored by: Robert Klemme
-  - Fixed handling of filters with "split-large-forms 1"
-    when using the CGI editor.
-    Reported by withoutname in #921.
-  - Better detect a mismatch of connection details when
-    figuring out whether or not a connection can be reused.
-  - Don't send a "Connection failure" message instead of the
-    "DNS failure" message.
-    Sponsored by: Robert Klemme
-  - Let LOG_LEVEL_REQUEST log all requests. Previously unencrypted
-    requests were only logged with LOG_LEVEL_REQUEST when they weren't
-    crunched (in which case they were logged with LOG_LEVEL_CRUNCH).
-    This was documented behaviour, but logging all requests seems more useful.
-  - Fixed locking around localtime() and gmtime().
-  - Removed OS/2 support. We haven't provided OS/2 packages in years,
-    it complicated the code and it depended on a fallback snprintf()
-    implementation which is GPLv2 only.
-  - Remove the fallback snprintf() implementation
-    Now that OS/2 support is gone we no longer need it.
-  - Fixed a bunch of format specifiers log messages.
-  - Added a missing apostrophe in the 'More Privoxy' menu.
-  - Explicitly prevent use of FEATURE_CONNECTION_SHARING
-    without FEATURE_CONNECTION_KEEP_ALIVE. It makes no sense
-    and does not compile anyway.
-    Sponsored by: Robert Klemme
-  - Fix build without FEATURE_CONNECTION_KEEP_ALIVE.
-    Sponsored by: Robert Klemme
-  - Downgrade the 'Graceful termination requested' message
-    to LOG_LEVEL_INFO as it isn't an error.
-    Sponsored by: Robert Klemme
-  - decompress_iob(): Downgrade the no-content message to LOG_LEVEL_RE_FILTER
-    While at it, fix a typo in a comment.
-    Sponsored by: Robert Klemme
-  - Fixed a couple of cppcheck warnings.
-  - Rename LOG_LEVEL_GPC to LOG_LEVEL_REQUEST.
-    Only the shadow knows what "GPC" is supposed to stand for.
-  - Remove SourceForge references in copyright headers.
-  - Upgrade a bunch of links to the homepage to https://.
-  - Add 'no-brotli-accepted' filter which prevents the
-    use of Brotli compression.
-  - Changed license for pcrs to GPLv2+ after getting the
-    permission from Andreas. This allows to redistribute
-    Privoxy under the GPLv3 which is required when linking
-    to future mbedTLS versions which are expected to be
-    licensed under the Apache 2.0 license only.
-  - Updated a bunch of tests that have to expect status code 403
-    now after r1.168/070e904afa5.
-  - Lowercase the host name in the request line.
-  - Only set SOURCE_DATE_EPOCH if it's not already set so
-    distributions can overwrite it through the environment.
-
-- Documentation changes:
-  - Explain that Privoxy has to be distributed under the
-    GPLv3 (or later) when linked with an MbedTLS version
-    that is licensed under the Apache 2.0 license.
-  - Import the GNU GPLv3 and include it the user manual.
-  - Clarify FEATURE_FORCE_LOAD's description. It allows to bypass
-    blocking not filtering and only does it if blocks aren't enforced.
-    Reported by: Robert Klemme
-  - FAQ: Remove Zwiebelfreunde e.V. from the list of fiduciary sponsors
-    As of 2021 they no longer handle donations for foreign organisations
-    due to lack of resources.
-  - FAQ: Remove an obsolete comment with a link to the long-gone PDF manual.
-  - FAQ: Add a link to the TODO list.
-  - FAQ: Change the sponsor amounts to USD slightly rounding the
-    converted amounts up to get simple numbers.
-    Receiving USD is apparently easier for SPI and SPI is
-    preferred by sponsors as they can send invoices.
-  - Advertise the client-tags CGI page in the user manual.
-  - Stop advertising the show-version CGI page which no longer exists.
-  - Add yet another reason why +prevent-compression may cause problems.
-  - Don't claim that contributors need ssh. It's only needed for committers.
-  - Replace obsolete CVS instructions with Git instructions.
-  - Remove an obsolete comment
-
-- Config file changes:
-  - Change the suggested default-server-timeout to 5 to match the
-    suggested keep-alive-timeout. Otherwise using the defaults would
-    result in Privoxy reducing the default-server-timeout and logging
-    an error message.
-    Sponsored by: Robert Klemme
-  - Update the 'debug 1' description.
-  - Add a missing 'client-specific-tag' directive.
-  - Comment out trusted-cgi-referer pointing to example.org.
+  - 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:
-  - Block requests to /(.*/)?piwik\.php
-  - Block requests to .connectaserver.de/
-  - Block requests to pixel.inforsea.com/
-  - Block requests to t.vi-serve.com/
-  - Block requests to .ioam.de/
-  - Block requests to t.9gag.com/img.gif
-  - Block requests to .pixel.parsely.com/ as image
-  - Block requests to pixel.wp.com/
-  - Disable fast-redirects for .librarything.com/
-  - Disable fast-redirects for issue.freebsdfoundation.org/
-  - Disable fast-redirects for .twitter.com/.*origin=http
-  - Unblock belco24.de/
-  - Add fast-redirects exception for .wikipedia.org/
-  - Add fast-redirects exception for oss-fuzz.com/
-  - Disable fast-redirects for .consensu.org/delivery/pixel\.php
-    and block the requests as image instead
-  - Unblock .adbinstaller.com/
-    Reported by lvm in #942.
-  - Unblock .adbshell.com
-    Reported by lvm in #942.
-  - Unblock .tagesschau.de/
-  - Disable fast-redirects for collector.githubapp.com/
-    and block requests to it as image instead
-  - Unblock 'ada*.'
-  - Add fast-redirects{} exception for sourcepoint.vice.com/
-  - Unblock adaway.org/
-    Reported by DRS David Soft in AF#945.
-  - Change two block reasons that previously were the same.
-    Sponsored by: Robert Klemme
-  - Added a +delay-response{} test.
-  - Updated the location of the development version
-    of default.action.master.
+  - 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:
-  - Added a --keep-date option to keep the date in highlighted messages.
-  - Highlight new log messages.
-  - Make gather_loglevel_clf_stats() more tolerant. While at it,
-    count all CLF messages as requests, even if the request is invalid.
-  - Only show HTTP version distribution if at least one version has been detected.
-  - Only show crunch statistics if crunches were detected.
-  - Warn if the request counts differ.
-  - Generate statistics if the log only contains LOG_LEVEL_CLF messages
-    so it can be used with vanilla webserver logs.
-    Previously Privoxy-specific "Request:" messages were required.
-  - Align the client-HTTP-version distribution like other distributions
-  - Bump version to 0.9.1
-  - Include status code distribution in the stats.
-  - Let the statistics include the size of the content Privoxy
-    transferred excluding HTTP headers.
-  - Get with the program and expect all requests to be logged with LOG_LEVEL_REQUEST.
-    It's no longer necessary to count both LOG_LEVEL_REQUEST and
-    LOG_LEVEL_CRUNCH messages to get the total number of requests.
-  - Leverage the LOG_LEVEL_CLF message to gather statistics that where
-    previously taken from LOG_LEVEL_HEADER lines. This results in less
-    confusing results if https inspection is enabled in which case there
-    are two LOG_LEVEL_HEADER lines with request lines.
-    Sponsored by: Robert Klemme
-  - Properly highlight the filter results message. Previously a brace got lost.
-  - Prefer the number of CLF lines to get the total number of requests
-    as it works with older Privoxy versions as well.
+  - 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:
-  - Turn curl's globbing mode off so we can allow more characters in URLs.
-  - Allow '[' and ']' in URLs.
-  - Include the action file when complaining about missing Sticky Actions.
-  - Fix a sentence in the documentation.
-  - Bump version to 0.7.1
-
-- url-pattern-translator:
-  - Detect a couple of pattern prefixes case-insensitively.
-    Sponsored by: Robert Klemme
-  - Skip CLIENT-TAG patterns.
-    Sponsored by: Robert Klemme
-  - Skip patterns that have already been converted.
-    It should now be safe to "convert" a file multiple times.
-    Sponsored by: Robert Klemme
-  - Add the new 'PCRE-HOST-PATTERN:' prefix.
-    Sponsored by: Robert Klemme
-
+  - 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:
@@ -260,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:
 
-  * https://www.privoxy.org/faq/general.html#PARTICIPATE
+  * https://www.privoxy.org/participate
 
-  * https://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), 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