Update SGML changelog
authorFabian Keil <fk@fabiankeil.de>
Mon, 6 Dec 2021 13:34:25 +0000 (14:34 +0100)
committerFabian Keil <fk@fabiankeil.de>
Mon, 6 Dec 2021 13:37:19 +0000 (14:37 +0100)
doc/source/changelog.sgml

index 48b759d..c6d086e 100644 (file)
 -->
 
 <para>
-  <application>Privoxy 3.0.32</application> fixes multiple DoS issues
-  and a couple of other bugs. The issues also affect earlier Privoxy
-  releases.
+  <application>Privoxy 3.0.33</application> fixes an XSS issue
+  and multiple DoS issues and a couple of other bugs.
+  The issues also affect earlier Privoxy releases.
+  <application>Privoxy 3.0.33</application> also comes with
+  a couple of general improvements an new features.
 </para>
- <para>
-  Changes in <application>Privoxy 3.0.32</application> stable:
- </para>
- <para>
+<para>
+  Changes in <application>Privoxy 3.0.33</application> stable:
+</para>
+<para>
  <itemizedlist>
   <listitem>
    <para>
-    Security/Reliability:
+    Bug fixes:
     <itemizedlist>
     <listitem>
      <para>
-      ssplit(): Remove an assertion that could be triggered with a
-      crafted CGI request.
-      Commit 2256d7b4d67. OVE-20210203-0001.
-      Reported by: Joshua Rogers (Opera)
+      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.
      </para>
     </listitem>
     <listitem>
      <para>
-      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)
+      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.
      </para>
     </listitem>
     <listitem>
      <para>
-      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)
+      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.
      </para>
     </listitem>
     <listitem>
      <para>
-      chunked_body_is_complete(): Prevent an invalid read of size two.
-      Commit a912ba7bc9c. OVE-20210205-0001.
-      Reported by: Joshua Rogers (Opera)
+      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.
      </para>
     </listitem>
     <listitem>
      <para>
-      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 2008 already.
-      Commit 28512e5b624. OVE-20210222-0001.
-      Reported by: Joshua Rogers (Opera)
+      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.
+     </para>
+    </listitem>
+    <listitem>
+     <para>
+      load_config(): Add a space that was missing in a log message.
      </para>
      </listitem>
     </itemizedlist>
   </listitem>
   <listitem>
    <para>
-    Bug fixes:
+    General improvements:
     <itemizedlist>
     <listitem>
      <para>
-      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)
+      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.
+     </para>
+    </listitem>
+    <listitem>
+     <para>
+      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.
+     </para>
+    </listitem>
+    <listitem>
+     <para>
+      handle_established_connection(): Slightly improve a comment
+     </para>
+    </listitem>
+    <listitem>
+     <para>
+      handle_established_connection(): Fix a comment
+     </para>
+    </listitem>
+    <listitem>
+     <para>
+      socks5_connect(): Fix indentation.
+     </para>
+    </listitem>
+    <listitem>
+     <para>
+      handle_established_connection(): Improve an error message
+     </para>
+    </listitem>
+    <listitem>
+     <para>
+      create_pattern_spec(): Fix ifdef indentation
+     </para>
+    </listitem>
+    <listitem>
+     <para>
+      Fix comment typos
+     </para>
+    </listitem>
+    <listitem>
+     <para>
+      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.
+     </para>
+    </listitem>
+    <listitem>
+     <para>
+      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.
+     </para>
+    </listitem>
+    <listitem>
+     <para>
+      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.
+     </para>
+    </listitem>
+    <listitem>
+     <para>
+      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.
+     </para>
+    </listitem>
+    <listitem>
+     <para>
+      read_http_request_body(): Fix two error messages that used an incorrect variable.
+     </para>
+    </listitem>
+    <listitem>
+     <para>
+      chat(): Log the applied actions before deciding how to forward the request.
      </para>
     </listitem>
     <listitem>
      <para>
-      decompress_iob(): Prevent reading of uninitialized data.
-      Reported by: Joshua Rogers (Opera).
+      parse_time_header(): Silence a coverity complaint when building without assertions.
      </para>
     </listitem>
     <listitem>
      <para>
-      decompress_iob(): Don't advance cur past eod when looking
-      for the end of the file name and comment.
+      receive_encrypted_request_headers(): Improve a log message
      </para>
     </listitem>
     <listitem>
      <para>
-      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)
+      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.
      </para>
     </listitem>
     <listitem>
      <para>
-      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).
+      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.
      </para>
     </listitem>
     <listitem>
      <para>
-      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)
+      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.
      </para>
     </listitem>
     <listitem>
      <para>
-      log_error(): Treat LOG_LEVEL_FATAL as fatal even when --stfu is
-      being used while fuzzing.
-      Reported by: Joshua Rogers (Opera).
+      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
      </para>
     </listitem>
     <listitem>
      <para>
-      Respect DESTDIR when considering whether or not to install
-      config files with ".new" extension.
+      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.
      </para>
     </listitem>
     <listitem>
      <para>
-      OpenSSL ssl_store_cert(): Fix two error messages.
+      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@.
      </para>
     </listitem>
     <listitem>
      <para>
-      Fix a couple of format specifiers.
+      OpenSSL generate_host_certificate(): Fix two error messsages.
      </para>
     </listitem>
     <listitem>
      <para>
-      Silence compiler warnings when compiling with NDEBUG.
+      Improve description of handle_established_connection()
      </para>
     </listitem>
     <listitem>
      <para>
-      fuzz_server_header(): Fix compiler warning.
+      OpenSSL ssl_store_cert(): Translate EVP_PKEY_EC to a string.
      </para>
     </listitem>
     <listitem>
      <para>
-      fuzz_client_header(): Fix compiler warning.
+      OpenSSL ssl_store_cert(): Remove pointless variable initialization.
      </para>
     </listitem>
     <listitem>
      <para>
-      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.
+      OpenSSL ssl_store_cert(): Initialize pointer with NULL instead of 0.
      </para>
      </listitem>
     </itemizedlist>
   </listitem>
   <listitem>
    <para>
-    General improvements:
+    Action file improvements:
     <itemizedlist>
     <listitem>
      <para>
-      Log the TLS version and the the cipher when debug 2 is enabled.
+      Disable fast-redirects for .microsoftonline.com/.
      </para>
     </listitem>
     <listitem>
      <para>
-      ssl_send_certificate_error(): Respect HEAD requests by not sending a body.
+      Disable fast-redirects for idp.springer.com/.
      </para>
     </listitem>
     <listitem>
      <para>
-      ssl_send_certificate_error(): End the body with a single new line.
+      Disable fast-redirects for .zeit.de/zustimmung
      </para>
     </listitem>
     <listitem>
      <para>
-      serve(): Increase the chances that the host is logged when closing
-      a server socket.
+      Unblock adv-archiv.dfn-cert.de/
      </para>
     </listitem>
     <listitem>
      <para>
-      handle_established_connection(): Add parentheses to clarify an expression
-      Suggested by: David Binderman
+      Block requests to eu-tlp01.kameleoon.eu/
      </para>
     </listitem>
     <listitem>
      <para>
-      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).
+      Block requests to fpa-events.arstechnica.com/
      </para>
     </listitem>
     <listitem>
      <para>
-      decompress_iob(): Add periods to a couple of log messages
+      Unblock nlnet.nl/.
      </para>
     </listitem>
     <listitem>
      <para>
-      Terminate the body of the HTTP snipplets with a single new line
-      instead of "\r\n".
+      Unblock adguard.com/.
+     </para>
+     </listitem>
+    </itemizedlist>
+   </para>
+  </listitem>
+  <listitem>
+   <para>
+    Privoxy-Log-Parser:
+    <itemizedlist>
+    <listitem>
+     <para>
+      Highlight 'Socket timeout 3 reached: http://127.0.0.1:20000/no-filter/chunked-content/36'
+     </para>
+    </listitem>
+    <listitem>
+     <para>
+      Improve documentation for inactivity-detection mode
+     </para>
+    </listitem>
+    <listitem>
+     <para>
+      Detect date changes when looking for inactivity
+     </para>
+    </listitem>
+    <listitem>
+     <para>
+      Add a --passed-request-statistics-threshold option
+      That can be set to get statistics for requests that
+      were passed.
+     </para>
+    </listitem>
+    <listitem>
+     <para>
+      Add a "inactivity detection" mode
+      Which can be useful for debugging purposes.
+     </para>
+    </listitem>
+    <listitem>
+     <para>
+      Bump version to 0.9.4
      </para>
     </listitem>
     <listitem>
      <para>
-      configure: Add --with-assertions option and only enable assertions
-      when it is used
+      Only run print_intro() and print_outro() when syntax highlighting
      </para>
     </listitem>
     <listitem>
      <para>
-      windows build: Use --with-brotli and --with-mbedtls by default and
-      enable dynamic error checking.
+      Rephrase a sentence in the documentation
      </para>
     </listitem>
     <listitem>
      <para>
-      gif_deanimate(): Confirm we've got an image before trying to write it
-      Saves a pointless buf_copy() call.
+      Highlight 'Client socket 7 is no longer usable. The server socket has been closed.'
      </para>
     </listitem>
     <listitem>
      <para>
-      OpenSSL ssl_store_cert(): Remove a superfluous space before the serial number.
+      Clarify --statistics output
+      by explicitly mentioning that the status codes
+      sent by the server may differ from the ones in
+      "debug 512" messages.
+     </para>
+    </listitem>
+    <listitem>
+     <para>
+      Fix typo in the --statistics output
+     </para>
+    </listitem>
+    <listitem>
+     <para>
+      Remove an unused variable
+     </para>
+    </listitem>
+    <listitem>
+     <para>
+      Highlight 'The peer notified us that the connection on socket 11 is going to be closed'
      </para>
      </listitem>
     </itemizedlist>
   </listitem>
   <listitem>
    <para>
-    Action file improvements:
+    Privoxy-Regression-Test:
     <itemizedlist>
     <listitem>
      <para>
-      Disable fast-redirects for .golem.de/
+      Remove duplicated word in a comment.
+     </para>
+     </listitem>
+    </itemizedlist>
+   </para>
+  </listitem>
+  <listitem>
+   <para>
+    regression-tests.action:
+    <itemizedlist>
+    <listitem>
+     <para>
+      Add fetch test for http://p.p/wpad.dat.
+     </para>
+    </listitem>
+    <listitem>
+     <para>
+      Bump for-privoxy-version to 3.0.33 which introduced the wpad.dat support.
      </para>
     </listitem>
     <listitem>
      <para>
-      Unblock requests to adri*.
+      Add more tests for the '/send-banner' code.
      </para>
     </listitem>
     <listitem>
      <para>
-      Block requests for trc*.taboola.com/
+      Add test for OVE-20210203-0001.
      </para>
     </listitem>
     <listitem>
      <para>
-      Disable fast-redirects for .linkedin.com/
+      Add a test for CVE-2021-20217.
      </para>
      </listitem>
     </itemizedlist>
   </listitem>
   <listitem>
    <para>
-    Filter file improvements:
+    uagen:
     <itemizedlist>
     <listitem>
      <para>
-      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/.
+      Bump generated Firefox version to 91 (ESR)
      </para>
     </listitem>
+    <listitem>
+     <para>
+      Bump version to 1.2.3
+     </para>
+    </listitem>
+    <listitem>
+     <para>
+      Bump copyright
+     </para>
+     </listitem>
     </itemizedlist>
    </para>
   </listitem>
   <listitem>
    <para>
-    Privoxy-Log-Parser:
+    Build system:
     <itemizedlist>
     <listitem>
      <para>
-      Highlight a few more messages.
+      configure: Bump SOURCE_DATE_EPOCH.
+     </para>
+    </listitem>
+    <listitem>
+     <para>
+      GNUmakefile.in: Fix typo.
+     </para>
+    </listitem>
+    <listitem>
+     <para>
+      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.
+     </para>
+    </listitem>
+    <listitem>
+     <para>
+      Add configure option to enable MemorySanitizer.
      </para>
     </listitem>
     <listitem>
      <para>
-      Clarify the --statistics output. The shown "Reused connections"
-      are server connections so name them appropriately.
+      Add configure option to enable UndefinedBehaviorSanitizer.
      </para>
     </listitem>
     <listitem>
      <para>
-      Bump version to 0.9.3.
+      Add configure option to enable AddressSanitizer.
+     </para>
+    </listitem>
+    <listitem>
+     <para>
+      Bump copyright
+     </para>
+    </listitem>
+    <listitem>
+     <para>
+      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.
+     </para>
+    </listitem>
+    <listitem>
+     <para>
+      configure: Remove obsolete RPM_BASE check
      </para>
      </listitem>
     </itemizedlist>
   </listitem>
   <listitem>
    <para>
-    Privoxy-Regression-Test:
+    Windows build system:
     <itemizedlist>
     <listitem>
      <para>
-      Add the --check-bad-ssl option to the --help output.
+      Update the build script to use mbed tls version 2.6.11.
+     </para>
+    </listitem>
+    <listitem>
+     <para>
+      Update build script to use the final 8.45 pcre library.
      </para>
     </listitem>
     <listitem>
      <para>
-      Bump version to 0.7.3.
+      Put all the '--enable-xxx' options in the configure call together.
      </para>
      </listitem>
     </itemizedlist>
     <itemizedlist>
     <listitem>
      <para>
-      Add pushing the created tag to the release steps in the developer manual.
+      contacting: Remove obsolete reference to announce.sgml.
      </para>
     </listitem>
     <listitem>
      <para>
-      Clarify that 'debug 32768' should be used in addition to the other debug
-      directives when reporting problems.
+      contacting: Request that the browser cache is cleared before
+      producing a log file for submission.
      </para>
-     </listitem>
+    </listitem>
+    <listitem>
+     <para>
+      Sponsor FAQ: Note that Privoxy users may follow sponsor links
+      without Referer header set.
+     </para>
+    </listitem>
+    <listitem>
+     <para>
+      newfeatures: Clarify that https inspection also allows to
+      filter https responses.
+     </para>
+    </listitem>
     <listitem>
      <para>
-      Add a 'Third-party licenses and copyrights' section to the user manual.
+      developer-manual: Mention that announce.txt should be updated
+      when doing a release.
      </para>
     </listitem>
+    <listitem>
+     <para>
+      config: Explicitly mention that the CGI pages disclosing the
+      ca-password can be blocked and upgrade the disclosure paragraphs
+      to a warning.
+     </para>
+    </listitem>
+    <listitem>
+     <para>
+      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.
+     </para>
+    </listitem>
+    <listitem>
+     <para>
+      Update TODO list item #184 to note that WolfSSL support will
+      (hopefully) appear after the 3.0.34 release
+     </para>
+    </listitem>
+    <listitem>
+     <para>
+      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.
+     </para>
+    </listitem>
+    <listitem>
+     <para>
+      Add a warning that the socket-timeout does not apply
+      to operations done by TLS libraries
+     </para>
+    </listitem>
+    <listitem>
+     <para>
+      Make documentation slightly less "offensive" for some people
+      by avoiding the word "hell".
+     </para>
+     </listitem>
     </itemizedlist>
    </para>
   </listitem>