Regenerate docs
[privoxy.git] / doc / webserver / user-manual / whatsnew.html
index dd7d25f..954b9e5 100644 (file)
-<HTML
-><HEAD
-><TITLE
->What's New in this Release</TITLE
-><META
-NAME="GENERATOR"
-CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+
-"><LINK
-REL="HOME"
-TITLE="Privoxy 3.0.7 User Manual"
-HREF="index.html"><LINK
-REL="PREVIOUS"
-TITLE="Installation"
-HREF="installation.html"><LINK
-REL="NEXT"
-TITLE="Quickstart to Using Privoxy"
-HREF="quickstart.html"><LINK
-REL="STYLESHEET"
-TYPE="text/css"
-HREF="../p_doc.css">
-<LINK REL="STYLESHEET" TYPE="text/css" HREF="p_doc.css">
-</head
-><BODY
-CLASS="SECT1"
-BGCOLOR="#EEEEEE"
-TEXT="#000000"
-LINK="#0000FF"
-VLINK="#840084"
-ALINK="#0000FF"
-><DIV
-CLASS="NAVHEADER"
-><TABLE
-SUMMARY="Header navigation table"
-WIDTH="100%"
-BORDER="0"
-CELLPADDING="0"
-CELLSPACING="0"
-><TR
-><TH
-COLSPAN="3"
-ALIGN="center"
->Privoxy 3.0.7 User Manual</TH
-></TR
-><TR
-><TD
-WIDTH="10%"
-ALIGN="left"
-VALIGN="bottom"
-><A
-HREF="installation.html"
-ACCESSKEY="P"
->Prev</A
-></TD
-><TD
-WIDTH="80%"
-ALIGN="center"
-VALIGN="bottom"
-></TD
-><TD
-WIDTH="10%"
-ALIGN="right"
-VALIGN="bottom"
-><A
-HREF="quickstart.html"
-ACCESSKEY="N"
->Next</A
-></TD
-></TR
-></TABLE
-><HR
-ALIGN="LEFT"
-WIDTH="100%"></DIV
-><DIV
-CLASS="SECT1"
-><H1
-CLASS="SECT1"
-><A
-NAME="WHATSNEW"
-></A
->3. What's New in this Release</H1
-><P
-> There are many improvements and new features since <SPAN
-CLASS="APPLICATION"
->Privoxy 3.0.6</SPAN
->, the last stable release:</P
-><P
-> <P
-></P
-><UL
-><LI
-><P
->    Header filtering can be done with dedicated header filters now. As a result
-    the actions <SPAN
-CLASS="QUOTE"
->"filter-client-headers"</SPAN
-> and <SPAN
-CLASS="QUOTE"
->"filter-server-headers"</SPAN
->
-    that were introduced with <SPAN
-CLASS="APPLICATION"
->Privoxy 3.0.5</SPAN
-> to apply
-    the content filters to the headers as, well have been removed again.
-   </P
-></LI
-></UL
-></P
-><DIV
-CLASS="SECT2"
-><H2
-CLASS="SECT2"
-><A
-NAME="UPGRADERSNOTE"
-></A
->3.1. Note to Upgraders</H2
-><P
-> A quick list of things to be aware of before upgrading from earlier 
- versions of <SPAN
-CLASS="APPLICATION"
->Privoxy</SPAN
->:</P
-><P
-> <P
-></P
-><UL
-><LI
-><P
->  
-    Some installers may remove earlier versions completely, including 
-    configuration files. Save any important configuration files!
-  </P
-></LI
-><LI
-><P
->  
-   On the other hand, other installers may not overwrite any existing configuration 
-   files, thinking you will want to do that. You may want to manually check 
-   your saved files against the newer versions to see if the improvements have
-   merit, or whether there are new options that you may want to consider.
-   There are a number of new features, but most won't be available unless 
-   these features are incorporated into your configuration somehow.
-  </P
-></LI
-><LI
-><P
->     See the full documentation on 
-     <TT
-CLASS="LITERAL"
-><A
-HREF="actions-file.html#FAST-REDIRECTS"
->fast-redirects</A
-></TT
->
-     which has changed syntax, and will require adjustments to local configs, 
-     such as <TT
-CLASS="FILENAME"
->user.action</TT
->. You must reference the new 
-     syntax: 
-   </P
-><P
-> <TABLE
-BORDER="0"
-BGCOLOR="#E0E0E0"
-WIDTH="90%"
-><TR
-><TD
-><PRE
-CLASS="SCREEN"
->  { +fast-redirects{check-decoded-url} }
-   .example.com
-   mybank.com
-   .google.</PRE
-></TD
-></TR
-></TABLE
-></P
-></LI
-><LI
-><P
->     The <TT
-CLASS="FILENAME"
->jarfile</TT
->, 
-     <A
-HREF="http://en.wikipedia.org/wiki/Browser_cookie"
-TARGET="_top"
->cookie</A
-> logger, is off by default now.
-    </P
-></LI
-><LI
-><P
->  
-   What constitutes a <SPAN
-CLASS="QUOTE"
->"default"</SPAN
-> configuration has changed, 
-   and you may want to review which actions are <SPAN
-CLASS="QUOTE"
->"on"</SPAN
-> by 
-   default. This is primarily a matter of emphasis, but some features 
-   you may have been used to, may now be <SPAN
-CLASS="QUOTE"
->"off"</SPAN
-> by default.
-   There are also a number of new actions and filters you may want to
-   consider, most of which are not fully incorporated into the default
-   settings as yet (see above).
-  </P
-></LI
-><LI
-><P
->    The default actions setting is now <TT
-CLASS="LITERAL"
->Cautious</TT
->. Previous
-    releases had a default setting of <TT
-CLASS="LITERAL"
->Medium</TT
->. Experienced
-    users may want to adjust this, as it is fairly conservative by <SPAN
-CLASS="APPLICATION"
->Privoxy</SPAN
->
-    standards and past practices. See <A
-HREF="http://config.privoxy.org/edit-actions-list?f=default"
-TARGET="_top"
->    http://config.privoxy.org/edit-actions-list?f=default</A
->. New users
-    should try the default settings for a while before turning up the volume.
-   </P
-></LI
-><LI
-><P
->    The default setting has filtering turned <SPAN
-CLASS="emphasis"
-><I
-CLASS="EMPHASIS"
->off</I
-></SPAN
->, which
-    subsequently means that compression is <SPAN
-CLASS="emphasis"
-><I
-CLASS="EMPHASIS"
->on</I
-></SPAN
->. Remember
-    that filtering does not work on compressed pages, so if you use, or want to
-    use, filtering, you will need to force compression off. Example:
-   </P
-><P
-> <TABLE
-BORDER="0"
-BGCOLOR="#E0E0E0"
-WIDTH="90%"
-><TR
-><TD
-><PRE
-CLASS="SCREEN"
->  { +<A
-HREF="actions-file.html#FILTER"
->filter</A
->{google}  +<A
-HREF="actions-file.html#PREVENT-COMPRESSION"
->prevent-compression</A
-> }
-   .google.</PRE
-></TD
-></TR
-></TABLE
->
-   </P
-><P
->    Or if you use a number of filters, or filter many sites, you may just want
-    to turn off compression for all sites in
-    <TT
-CLASS="FILENAME"
->default.action</TT
-> (or
-    <TT
-CLASS="FILENAME"
->user.action</TT
->). 
-   </P
-></LI
-><LI
-><P
->   Also, <A
-HREF="actions-file.html#SESSION-COOKIES-ONLY"
->session-cookies-only</A
-> is 
-   off by default now. If you've liked this feature in the past, you may want 
-   to turn it back on in <TT
-CLASS="FILENAME"
->user.action</TT
-> now.
-  </P
-></LI
-><LI
-><P
->   
-   Some installers may not automatically start
-   <SPAN
-CLASS="APPLICATION"
->Privoxy</SPAN
-> after installation.
-  </P
-></LI
-></UL
-></P
-></DIV
-></DIV
-><DIV
-CLASS="NAVFOOTER"
-><HR
-ALIGN="LEFT"
-WIDTH="100%"><TABLE
-SUMMARY="Footer navigation table"
-WIDTH="100%"
-BORDER="0"
-CELLPADDING="0"
-CELLSPACING="0"
-><TR
-><TD
-WIDTH="33%"
-ALIGN="left"
-VALIGN="top"
-><A
-HREF="installation.html"
-ACCESSKEY="P"
->Prev</A
-></TD
-><TD
-WIDTH="34%"
-ALIGN="center"
-VALIGN="top"
-><A
-HREF="index.html"
-ACCESSKEY="H"
->Home</A
-></TD
-><TD
-WIDTH="33%"
-ALIGN="right"
-VALIGN="top"
-><A
-HREF="quickstart.html"
-ACCESSKEY="N"
->Next</A
-></TD
-></TR
-><TR
-><TD
-WIDTH="33%"
-ALIGN="left"
-VALIGN="top"
->Installation</TD
-><TD
-WIDTH="34%"
-ALIGN="center"
-VALIGN="top"
->&nbsp;</TD
-><TD
-WIDTH="33%"
-ALIGN="right"
-VALIGN="top"
->Quickstart to Using Privoxy</TD
-></TR
-></TABLE
-></DIV
-></BODY
-></HTML
->
\ No newline at end of file
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
+"http://www.w3.org/TR/html4/loose.dtd">
+<html>
+<head>
+  <title>What's New in this Release</title>
+  <meta name="GENERATOR" content="Modular DocBook HTML Stylesheet Version 1.79">
+  <link rel="HOME" title="Privoxy 3.0.35 User Manual" href="index.html">
+  <link rel="PREVIOUS" title="Installation" href="installation.html">
+  <link rel="NEXT" title="Quickstart to Using Privoxy" href="quickstart.html">
+  <link rel="STYLESHEET" type="text/css" href="../p_doc.css">
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
+  <link rel="STYLESHEET" type="text/css" href="p_doc.css">
+</head>
+<body class="SECT1" bgcolor="#EEEEEE" text="#000000" link="#0000FF" vlink="#840084" alink="#0000FF">
+  <div class="NAVHEADER">
+    <table summary="Header navigation table" width="100%" border="0" cellpadding="0" cellspacing="0">
+      <tr>
+        <th colspan="3" align="center">Privoxy 3.0.35 User Manual</th>
+      </tr>
+      <tr>
+        <td width="10%" align="left" valign="bottom"><a href="installation.html" accesskey="P">Prev</a></td>
+        <td width="80%" align="center" valign="bottom"></td>
+        <td width="10%" align="right" valign="bottom"><a href="quickstart.html" accesskey="N">Next</a></td>
+      </tr>
+    </table>
+    <hr align="left" width="100%">
+  </div>
+  <div class="SECT1">
+    <h1 class="SECT1"><a name="WHATSNEW" id="WHATSNEW">3. What's New in this Release</a></h1>
+    <p><span class="APPLICATION">Privoxy 3.0.34</span> fixes a few minor bugs and comes with a couple of general
+    improvements and new features.</p>
+    <p>Changes in <span class="APPLICATION">Privoxy 3.0.34</span> stable:</p>
+    <ul>
+      <li>
+        <p>Bug fixes:</p>
+        <ul>
+          <li>
+            <p>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.</p>
+          </li>
+          <li>
+            <p>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.</p>
+          </li>
+          <li>
+            <p>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.</p>
+          </li>
+          <li>
+            <p>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.</p>
+          </li>
+          <li>
+            <p>can_filter_request_body(): Fix a log message that contained a spurious u.</p>
+          </li>
+          <li>
+            <p>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.</p>
+          </li>
+          <li>
+            <p>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.</p>
+          </li>
+          <li>
+            <p>socks5_connect(): Add support for target hosts specified as IPv4 address Previously the IP address was
+            sent as domain.</p>
+          </li>
+        </ul>
+      </li>
+      <li>
+        <p>General improvements:</p>
+        <ul>
+          <li>
+            <p>Add a client-body-tagger action which creates tags based on the content of the request body. Sponsored
+            by: Robert Klemme.</p>
+          </li>
+          <li>
+            <p>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.</p>
+          </li>
+          <li>
+            <p>Add periods to a couple of log messages.</p>
+          </li>
+          <li>
+            <p>accept_connection(): Add missing space to a log message.</p>
+          </li>
+          <li>
+            <p>Initialize ca-related defaults with strdup_or_die() so errors aren't silently ignored.</p>
+          </li>
+          <li>
+            <p>make_path: Use malloc_or_die() in cases where allocation errors were already fatal anyway.</p>
+          </li>
+          <li>
+            <p>handle_established_connection(): Improve an error message slightly.</p>
+          </li>
+          <li>
+            <p>receive_client_request(): Reject https URLs without CONNECT request.</p>
+          </li>
+          <li>
+            <p>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.</p>
+          </li>
+          <li>
+            <p>Add read_socks_reply() and start using it in socks5_connect() to apply the socket timeout more
+            consistently.</p>
+          </li>
+          <li>
+            <p>socks5_connect(): Deal with domain names in the socks reply</p>
+          </li>
+          <li>
+            <p>Add a filter for bundeswehr.de that hides the cookie and privacy info banner.</p>
+          </li>
+        </ul>
+      </li>
+      <li>
+        <p>Action file improvements:</p>
+        <ul>
+          <li>
+            <p>Disable filter{banners-by-size} for .freiheitsfoo.de/.</p>
+          </li>
+          <li>
+            <p>Disable filter{banners-by-size} for freebsdfoundation.org/.</p>
+          </li>
+          <li>
+            <p>Disable fast-redirects for consent.youtube.com/.</p>
+          </li>
+          <li>
+            <p>Block requests to ups.xplosion.de/.</p>
+          </li>
+          <li>
+            <p>Block requests for elsa.memoinsights.com/t.</p>
+          </li>
+          <li>
+            <p>Fix a typo in a test.</p>
+          </li>
+          <li>
+            <p>Disable fast-redirects for launchpad.net/.</p>
+          </li>
+          <li>
+            <p>Unblock .eff.org/.</p>
+          </li>
+          <li>
+            <p>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.</p>
+          </li>
+          <li>
+            <p>Unblock adfd.org/.</p>
+          </li>
+          <li>
+            <p>Disable filter{banners-by-link} for .eff.org/.</p>
+          </li>
+          <li>
+            <p>Block requests to odb.outbrain.com/.</p>
+          </li>
+          <li>
+            <p>Disable fast-redirects for .gandi.net/.</p>
+          </li>
+          <li>
+            <p>Disable fast-redirects{} for .onion/.*/status/.</p>
+          </li>
+          <li>
+            <p>Disable fast-redirects{} for twitter.com/.*/status/.</p>
+          </li>
+          <li>
+            <p>Unblock pinkstinks.de/.</p>
+          </li>
+          <li>
+            <p>Disable fast-redirects for .hagalil.com/.</p>
+          </li>
+        </ul>
+      </li>
+      <li>
+        <p>Privoxy-Log-Parser:</p>
+        <ul>
+          <li>
+            <p>Bump version to 0.9.5.</p>
+          </li>
+          <li>
+            <p>Highlight more log messages.</p>
+          </li>
+          <li>
+            <p>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.</p>
+          </li>
+        </ul>
+      </li>
+      <li>
+        <p>uagen:</p>
+        <ul>
+          <li>
+            <p>Bump version to 1.2.4.</p>
+          </li>
+          <li>
+            <p>Update BROWSER_VERSION and BROWSER_REVISION to 102.0 to match the User-Agent of the current Firefox
+            ESR.</p>
+          </li>
+          <li>
+            <p>Explicitly document that changing the 'Gecko token' is suspicious.</p>
+          </li>
+          <li>
+            <p>Consistently use a lower-case 'c' as copyright symbol.</p>
+          </li>
+          <li>
+            <p>Bump copyright.</p>
+          </li>
+          <li>
+            <p>Add 'aarch64' as Linux architecture.</p>
+          </li>
+          <li>
+            <p>Add OpenBSD architecture 'arm64'.</p>
+          </li>
+          <li>
+            <p>Stop using sparc64 as FreeBSD architecture. It hasn't been supported for a while now.</p>
+          </li>
+        </ul>
+      </li>
+      <li>
+        <p>Build system:</p>
+        <ul>
+          <li>
+            <p>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.</p>
+          </li>
+          <li>
+            <p>configure: Fix --with-msan option. Also (probably) reported by Andrew Savchenko.</p>
+          </li>
+        </ul>
+      </li>
+      <li>
+        <p>macOS build system:</p>
+        <ul>
+          <li>
+            <p>Enable HTTPS inspection when building the macOS binary (using OpenSSL as TLS library).</p>
+          </li>
+        </ul>
+      </li>
+      <li>
+        <p>Documentation:</p>
+        <ul>
+          <li>
+            <p>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.</p>
+          </li>
+          <li>
+            <p>config: Fix the documented ca-directory default value. Reported by avoidr.</p>
+          </li>
+          <li>
+            <p>Rebuild developer-manual and tidy with 'HTML Tidy for FreeBSD version 5.8.0'.</p>
+          </li>
+          <li>
+            <p>Update developer manual with new macOS packaging instructions.</p>
+          </li>
+          <li>
+            <p>Note that the FreeBSD installation instructions work for ElectroBSD as well.</p>
+          </li>
+          <li>
+            <p>Note that FreeBSD/ElectroBSD users can try to install Privoxy as binary package using 'pkg'.</p>
+          </li>
+        </ul>
+      </li>
+    </ul>
+    <div class="SECT2">
+      <h2 class="SECT2"><a name="UPGRADERSNOTE" id="UPGRADERSNOTE">3.1. Note to Upgraders</a></h2>
+      <p>A quick list of things to be aware of before upgrading from earlier versions of <span class=
+      "APPLICATION">Privoxy</span>:</p>
+      <ul>
+        <li>
+          <p>The recommended way to upgrade <span class="APPLICATION">Privoxy</span> is to backup your old
+          configuration files, install the new ones, verify that <span class="APPLICATION">Privoxy</span> is working
+          correctly and finally merge back your changes using <span class="APPLICATION">diff</span> and maybe
+          <span class="APPLICATION">patch</span>.</p>
+          <p>There are a number of new features in each <span class="APPLICATION">Privoxy</span> release and most of
+          them have to be explicitly enabled in the configuration files. Old configuration files obviously don't do
+          that and due to syntax changes using old configuration files with a new <span class=
+          "APPLICATION">Privoxy</span> isn't always possible anyway.</p>
+        </li>
+        <li>
+          <p>Note that some installers remove earlier versions completely, including configuration files, therefore you
+          should really save any important configuration files!</p>
+        </li>
+        <li>
+          <p>On the other hand, other installers don't overwrite existing configuration files, thinking you will want
+          to do that yourself.</p>
+        </li>
+        <li>
+          <p>In the default configuration only fatal errors are logged now. You can change that in the <a href=
+          "config.html#DEBUG">debug section</a> of the configuration file. You may also want to enable more verbose
+          logging until you verified that the new <span class="APPLICATION">Privoxy</span> version is working as
+          expected.</p>
+        </li>
+        <li>
+          <p>Three other config file settings are now off by default: <a href=
+          "config.html#ENABLE-REMOTE-TOGGLE">enable-remote-toggle</a>, <a href=
+          "config.html#ENABLE-REMOTE-HTTP-TOGGLE">enable-remote-http-toggle</a>, and <a href=
+          "config.html#ENABLE-EDIT-ACTIONS">enable-edit-actions</a>. If you use or want these, you will need to
+          explicitly enable them, and be aware of the security issues involved.</p>
+        </li>
+      </ul>
+    </div>
+  </div>
+  <div class="NAVFOOTER">
+    <hr align="left" width="100%">
+    <table summary="Footer navigation table" width="100%" border="0" cellpadding="0" cellspacing="0">
+      <tr>
+        <td width="33%" align="left" valign="top"><a href="installation.html" accesskey="P">Prev</a></td>
+        <td width="34%" align="center" valign="top"><a href="index.html" accesskey="H">Home</a></td>
+        <td width="33%" align="right" valign="top"><a href="quickstart.html" accesskey="N">Next</a></td>
+      </tr>
+      <tr>
+        <td width="33%" align="left" valign="top">Installation</td>
+        <td width="34%" align="center" valign="top">&nbsp;</td>
+        <td width="33%" align="right" valign="top">Quickstart to Using Privoxy</td>
+      </tr>
+    </table>
+  </div>
+</body>
+</html>