Update SGML ChangeLog for Privoxy 4.0.0
authorFabian Keil <fk@fabiankeil.de>
Tue, 7 Jan 2025 16:44:34 +0000 (17:44 +0100)
committerFabian Keil <fk@fabiankeil.de>
Tue, 7 Jan 2025 16:53:47 +0000 (17:53 +0100)
doc/source/changelog.sgml

index f4d6e00..7609357 100644 (file)
 -->
 
 <para>
-  <application>Privoxy 3.0.34</application> fixes a few
+  <application>Privoxy 4.0.0</application> fixes a few
   minor bugs and comes with a couple of general improvements
-  and new features.
+  and new features. HTTPS inspection is no
+  longer considered experimental.
 </para>
 <para>
-  Changes in <application>Privoxy 3.0.34</application> stable:
+  Two new features have been funded by donations. If you can,
+  please consider
+  <ulink url="https://www.privoxy.org/donate">making a donation</ulink>
+  to support future improvements.
+</para>
+<para>
+  Changes in <application>Privoxy 4.0.0</application> stable:
 </para>
 <para>
  <itemizedlist>
     <itemizedlist>
     <listitem>
      <para>
-      Improve the handling of chunk-encoded responses by buffering the data
-      even if filters are disabled and properly keeping track of where the
-      various chunks are supposed to start and end. Previously Privoxy would
-      merely check the last bytes received to see if they looked like the
-      last-chunk. This failed to work if the last-chunk wasn't received in one
-      read and could also result in actual data being misdetected
-      as last-chunk.
-      Should fix: SF support request #1739.
-      Reported by: withoutname.
+      Add missing client-body-tagger data to the action_type_info[] struct
+      so lookups based on the action index work correctly again.
+      Prevents assertion failures or segfaults when trying to edit
+      an action file with the CGI editor.
+      The type of failure depended on whether or not assertions
+      were enabled and on whether or not Privoxy had been compiled
+      with FEATURE_EXTERNAL_FILTERS.
+      Regression introduced in Privoxy 3.0.34.
+      Patch submitted by Aaron Li in #940.
      </para>
     </listitem>
     <listitem>
      <para>
-      remove_chunked_transfer_coding(): Refuse to de-chunk invalid data
-      Previously the data could get corrupted even further.
-      Now we simply pass the unmodified data to the client.
+      Bump MAX_FILTER_TYPES which should have been done in d128e6aa4
+      when introducing the client-body-tagger{} action.
+      Prevents an assertion in cgi_edit_actions_for_url() from triggering
+      after e32d03e0 when using the CGI editor with assertions enabled.
      </para>
     </listitem>
     <listitem>
      <para>
-      gif_deanimate(): Tolerate multiple image extensions in a row.
-      This allows to deanimate all the gifs on:
-      https://commons.wikimedia.org/wiki/Category:Animated_smilies
-      Fixes SF bug #795 reported by Celejar.
+      is_untrusted_url(): Search the encrypted headers for the Referer
+      when the client is using https and https inspection is enabled.
+      Fixes the trust mechanism for https requests.
+      Reported by Laurent Caumont in #1767.
      </para>
     </listitem>
     <listitem>
      <para>
-      OpenSSL generate_host_certificate(): Use X509_get_subject_name()
-      instead of X509_get_issuer_name() to get the issuer for generated
-      website certificates so there are no warnings in the browser when using
-      an intermediate CA certificate instead of a self-signed root certificate.
-      Problem reported and patch submitted by Chakib Benziane.
+      GNUMakefile.in: Let the install target work if no group is specified.
      </para>
     </listitem>
     <listitem>
      <para>
-      can_filter_request_body(): Fix a log message that contained a spurious u.
+      GNUMakefile.in: Set GROUP_T when installing configuration files as root
+      and there is no privoxy user available so the install target doesn't
+      fail. Patch by Fabrice Fontaine.
      </para>
     </listitem>
     <listitem>
      <para>
-      handle_established_connection(): Check for pending TLS data from the client
-      before checking if data is available on the connection.
-      The TLS library may have already consumed all the data from the client
-      response in which case poll() and select() will not detect that data is
-      available to be read.
-      Sponsored by: Robert Klemme.
+      GNUmakefile.in: Don't exit if configuration files are installed as root
+      as this can be considered acceptable when cross-compiling
+      Privoxy inside an autobuilder with only a root user.
+      Patch by Fabrice Fontaine.
      </para>
     </listitem>
     <listitem>
      <para>
-      ssl_send_certificate_error(): Don't crash if there's no certificate
-      information available. This is only relevant when Privoxy is built with
-      wolfSSL 5.0.0 or later (code not yet published). Earlier wolfSSL versions
-      or the other TLS backends don't seem to trigger the crash.
+      configure.in: Fix argument types in gmtime_r() and localtime_r() probes.
+      Otherwise these probes always fail with stricter compilers
+      even if there is C library support for these functions.
+      Patch submitted by Florian Weimer in SF#149.
      </para>
     </listitem>
     <listitem>
      <para>
-      socks5_connect(): Add support for target hosts specified as IPv4 address
-      Previously the IP address was sent as domain.
+      Fix socks4 and socks4a support under glibc's source fortification.
+      With glibc's source fortification, gcc offers the compilation warning
+      resulting in a runtime abort() when using a socks4 or socks4a upstream proxy.
+      Despite the warning, the strlcpy() call in question is fine: gcc
+      misidentifies the size of the destination buffer, estimating to hold
+      only a single char while in fact the buffer stretches beyond the end of
+      the struct socks_op.
+      The issue was originally reported in the NixOS issue tracker at
+      https://github.com/NixOS/nixpkgs/issues/265654
+      prompted by an upgrade of glibc from 2.37-39 to 2.38-0.
+      Patch submitted by Ingo Blechschmid, joint work with
+      @esclear and @richi235.
      </para>
      </listitem>
     </itemizedlist>
     <itemizedlist>
     <listitem>
      <para>
-      Add a client-body-tagger action which creates tags based on
-      the content of the request body.
-      Sponsored by: Robert Klemme.
+      Allow to use wolfSSL for https inspection.
+      wolfSSL supports TLS 1.3 and can be significantly faster than
+      mbedTLS. Mainly tested on ElectroBSD amd64 where it can
+      <ulink url="https://www.fabiankeil.de/gehacktes/privoxy-tls-benchmarks/">compete
+      with OpenSSL and LibreSSL</ulink>
+      To enable the support, install wolfSSL and run ./configure
+      with the --with-wolfssl option.
+      Sponsored by Privoxy project funds collected at SPI.
      </para>
     </listitem>
     <listitem>
      <para>
-      When client-body filters are enabled, buffer the whole request
-      before opening a connection to the server.
-      Makes it less likely that the server connection times out
-      and we don't open a connection if the buffering fails anyway.
-      Sponsored by: Robert Klemme.
+      Add an test framework that leverages the curl test suite.
+      Sponsored by Privoxy project funds collected at SPI.
      </para>
     </listitem>
     <listitem>
      <para>
-      Add periods to a couple of log messages.
+      Add pcre2 support. Closes bug #935.
+      Initial patch submitted by Gagan Sidhu.
      </para>
     </listitem>
     <listitem>
      <para>
-      accept_connection(): Add missing space to a log message.
+      Use SHA256 as hash algorithm for the certificate and key file names
+      instead of MD5. The known MD5 vulnerabilities shouldn't matter for
+      Privoxy's use case but it doesn't hurt to use a hash algorithm that
+      isn't deprecated.
+      Sponsored by: Robert Klemme
      </para>
     </listitem>
     <listitem>
      <para>
-      Initialize ca-related defaults with strdup_or_die() so errors
-      aren't silently ignored.
+      Add support for mbedTLS 3.x. This removes a sanity check
+      (whether issuer key and issuer certificate match) that seems
+      overly cautious and fails to compile with mbedTLS 3.x as the
+      struct members are private. We don't have an equivalent check
+      in the OpenSSL or wolfSSL code either.
      </para>
     </listitem>
     <listitem>
      <para>
-      make_path: Use malloc_or_die() in cases where allocation errors
-      were already fatal anyway.
+      Factor out newer_privoxy_version_required() and improve the logic
+      Previously 3.0.11 was considered newer than 4.0.0.
      </para>
     </listitem>
     <listitem>
      <para>
-      handle_established_connection(): Improve an error message slightly.
+      init_error_log(): Include the reason for failures to open the log file.
      </para>
     </listitem>
     <listitem>
      <para>
-      receive_client_request(): Reject https URLs without CONNECT request.
+      create_client_ssl_connection(): Don't keep the certificate lock
+      longer than necessary.
      </para>
     </listitem>
     <listitem>
      <para>
-      Include all requests in the statistics if mutexes are available.
-      Previously in case of reused connections only the last request got
-      counted. The statistics still aren't perfect but it's an improvement.
+      Add periods to a bunch of log messages.
      </para>
     </listitem>
     <listitem>
      <para>
-      Add read_socks_reply() and start using it in socks5_connect()
-      to apply the socket timeout more consistently.
+      normalize_lws(): Only log the 'Reducing whitespace ...' message
+      once per header
      </para>
     </listitem>
     <listitem>
      <para>
-      socks5_connect(): Deal with domain names in the socks reply
+      log_error() Win32: Only call LogShowActivity() for debug level
+      LOG_LEVEL_REQUEST. As of b94bbe62a950, which was part of Privoxy 3.0.29,
+      LOG_LEVEL_REQUEST is used for all requests including crunched ones.
+      Previously LogShowActivity() was called twice for crunched
+      requests, (presumably) resulting in an aborted animation.
      </para>
     </listitem>
     <listitem>
      <para>
-      Add a filter for bundeswehr.de that hides the cookie and
-      privacy info banner.
+      Remove ./ prefix from tarball-dist files.
      </para>
-     </listitem>
-    </itemizedlist>
-   </para>
-  </listitem>
-  <listitem>
-   <para>
-    Action file improvements:
-    <itemizedlist>
+    </listitem>
     <listitem>
      <para>
-      Disable filter{banners-by-size} for .freiheitsfoo.de/.
+      create_client_ssl_connection(): Make it more obvious from an
+      error message that a function failed.
      </para>
     </listitem>
     <listitem>
      <para>
-      Disable filter{banners-by-size} for freebsdfoundation.org/.
+      Use stringify() instead of section_target() and remove section_target().
+      Like the XXX comment suggested this could be done my moving the hash
+      into the templates which seems preferable anyway.
      </para>
     </listitem>
     <listitem>
      <para>
-      Disable fast-redirects for consent.youtube.com/.
+      Prevent some compiler warnings.
      </para>
     </listitem>
     <listitem>
      <para>
-      Block requests to ups.xplosion.de/.
+      parse_numeric_value(): Expect a base-ten number.
      </para>
     </listitem>
     <listitem>
      <para>
-      Block requests for elsa.memoinsights.com/t.
+      windows/MYconfigure: Have gcc diagnostics in color.
+     </para>
+     </listitem>
+    </itemizedlist>
+   </para>
+  </listitem>
+  <listitem>
+   <para>
+    Action file improvements:
+    <itemizedlist>
+    <listitem>
+     <para>
+      Block requests for .amazon-adsystem.com/
      </para>
     </listitem>
     <listitem>
      <para>
-      Fix a typo in a test.
+      Block requests to track.venatusmedia.com/
      </para>
     </listitem>
     <listitem>
      <para>
-      Disable fast-redirects for launchpad.net/.
+      Block requests to i.clean.gg/
      </para>
     </listitem>
     <listitem>
      <para>
-      Unblock .eff.org/.
+      Block requests to s.cpx.to/
      </para>
     </listitem>
     <listitem>
      <para>
-      Stop unblocking .org/.*(image|banner) which appears to be too generous
-      The example URL http://www.gnu.org/graphics/gnu-head-banner.png is
-      already unblocked due to .gnu.org being unblocked.
+      Block requests to secure-eu.nmrodam.com/
      </para>
     </listitem>
     <listitem>
      <para>
-      Unblock adfd.org/.
+      Block requests to o2.mouseflow.com/
      </para>
     </listitem>
     <listitem>
      <para>
-      Disable filter{banners-by-link} for .eff.org/.
+      Disable fast-redirects for services.akteneinsichtsportal.de/
      </para>
     </listitem>
     <listitem>
      <para>
-      Block requests to odb.outbrain.com/.
+      Disable fast-redirects for /wp-content/plugins/pdf-viewer-for-elementor
      </para>
     </listitem>
     <listitem>
      <para>
-      Disable fast-redirects for .gandi.net/.
+      Disable fast-redirects for syndication.twitter.com/
      </para>
     </listitem>
     <listitem>
      <para>
-      Disable fast-redirects{} for .onion/.*/status/.
+      Disable fast-redirects for archive.softwareheritage.org/
      </para>
     </listitem>
     <listitem>
      <para>
-      Disable fast-redirects{} for twitter.com/.*/status/.
+      Disable fast-redirects to duckduckgogg42xjoc72x3sjasowoarfbgcmvfimaftt6twagswzczad.onion/
      </para>
     </listitem>
     <listitem>
      <para>
-      Unblock pinkstinks.de/.
+      Disable fast-redirects for .creator-spring.com/_next/image
      </para>
     </listitem>
     <listitem>
      <para>
-      Disable fast-redirects for .hagalil.com/.
+      Disable fast redirects for accounts.bahn.de/
      </para>
-     </listitem>
-    </itemizedlist>
-   </para>
-  </listitem>
-  <listitem>
-   <para>
-    Privoxy-Log-Parser:
-    <itemizedlist>
+    </listitem>
     <listitem>
      <para>
-      Bump version to 0.9.5.
+      Unblock .datenschmutz.de/
      </para>
     </listitem>
     <listitem>
      <para>
-      Highlight more log messages.
+      Unblock requests for 'adventur*.'
      </para>
     </listitem>
     <listitem>
      <para>
-      Highlight the Crunch reason only once. Previously the "crunch reason"
-      could also be highlighted when the URL contained a matching string.
-      The real crunch reason only occurs once per line, so there's no need
-      to continue looking for it after it has been found once.
-      While at it, add a comment with an example log line.
+      Unblock adl.windows.com/
+      as it is apparently required to update from Windows 10 to 11.
+      Reported by Sam Varshavchik.
      </para>
      </listitem>
     </itemizedlist>
   </listitem>
   <listitem>
    <para>
-    uagen:
+    Privoxy-Log-Parser:
     <itemizedlist>
     <listitem>
      <para>
-      Bump version to 1.2.4.
+      Highlight 'Couldn't deliver the error message for [...]'.
      </para>
     </listitem>
     <listitem>
      <para>
-      Update BROWSER_VERSION and BROWSER_REVISION to 102.0
-      to match the User-Agent of the current Firefox ESR.
+      Highlight 'Failed to accept() incoming connection: Software caused connection abort'.
      </para>
     </listitem>
     <listitem>
      <para>
-      Explicitly document that changing the 'Gecko token' is suspicious.
+      Highlight 'Keeping chunk offset at 0 despite flushing 31 bytes.'.
      </para>
     </listitem>
     <listitem>
      <para>
-      Consistently use a lower-case 'c' as copyright symbol.
+      Highlight 'Not shutting down client connection on socket 8. The socket is no longer alive.'.
      </para>
     </listitem>
     <listitem>
      <para>
-      Bump copyright.
+      Bump version to 0.9.6.
      </para>
-    </listitem>
+     </listitem>
+    </itemizedlist>
+   </para>
+  </listitem>
+  <listitem>
+   <para>
+    Privoxy-Regression-Test.pl:
+    <itemizedlist>
     <listitem>
      <para>
-      Add 'aarch64' as Linux architecture.
+      Let the --min-level option increase the --max-level
+      if the latter is smaller than the former.
      </para>
     </listitem>
     <listitem>
      <para>
-      Add OpenBSD architecture 'arm64'.
+      Add --curl option to use a non-default curl binary.
      </para>
     </listitem>
     <listitem>
      <para>
-      Stop using sparc64 as FreeBSD architecture.
-      It hasn't been supported for a while now.
+      Bump version to 0.7.5.
      </para>
      </listitem>
     </itemizedlist>
   </listitem>
   <listitem>
    <para>
-    Build system:
+    uagen:
     <itemizedlist>
     <listitem>
      <para>
-      Makefile: Add a 'dok' target that depends on the 'error' target
-      to show the "You are not using GNU make or did nor run configure"
-      message.
+      Bump BROWSER_VERSION and BROWSER_REVISION to match Firefox ESR 128.
      </para>
     </listitem>
     <listitem>
      <para>
-      configure: Fix --with-msan option.
-      Also (probably) reported by Andrew Savchenko.
+      Bump version to 1.2.6.
      </para>
      </listitem>
     </itemizedlist>
   </listitem>
   <listitem>
    <para>
-    macOS build system:
+    Documentation:
     <itemizedlist>
     <listitem>
      <para>
-      Enable HTTPS inspection when building the macOS binary
-      (using OpenSSL as TLS library).
+      Add HOWTOs for https inspection and client-tags to user-manual.
      </para>
-     </listitem>
-    </itemizedlist>
-   </para>
-  </listitem>
-  <listitem>
-   <para>
-    Documentation:
-    <itemizedlist>
+    </listitem>
+    <listitem>
+     <para>
+      Suggest to use the force-text-mode action when filtering binary content
+      with external filters.
+     </para>
+    </listitem>
+    <listitem>
+     <para>
+      Declare https-inspection non-experimental.
+     </para>
+    </listitem>
     <listitem>
      <para>
-      Add OpenSSL to the list of libraries that may be licensed under the
-      Apache 2.0 license in which case the linked Privoxy binary has to be
-      distributed under the GPLv3 or later.
+      FAQ: Mention that
+      <ulink url="https://www.fabiankeil.de/gehacktes/privoxy-moral-license/">Privoxy
+      Moral Licenses</ulink> are available as well.
      </para>
     </listitem>
     <listitem>
      <para>
-      config: Fix the documented ca-directory default value.
-      Reported by avoidr.
+      Fix LibreSSL URL.
      </para>
     </listitem>
     <listitem>
      <para>
-      Rebuild developer-manual and tidy with 'HTML Tidy for FreeBSD version 5.8.0'.
+      Update perlre perldoc URL.
      </para>
     </listitem>
     <listitem>
      <para>
-      Update developer manual with new macOS packaging instructions.
+      config: Add SOCKS 5 to the list of supported protocols.
      </para>
     </listitem>
     <listitem>
      <para>
-      Note that the FreeBSD installation instructions work for
-      ElectroBSD as well.
+      In the Windows build section, note that one only needs tidy
+      to build the docs. If you're not building the docbook stuff you
+      don't need tidy.
      </para>
     </listitem>
     <listitem>
      <para>
-      Note that FreeBSD/ElectroBSD users can try to install Privoxy
-      as binary package using 'pkg'.
+      trust: Use the words 'allowlists' and 'blocklists'
+      instead of "whitelists" and "blacklists" which some
+      people consider to be less inclusive.
      </para>
      </listitem>
     </itemizedlist>