Rebuild docs with updated ChangeLog
[privoxy.git] / doc / webserver / user-manual / whatsnew.html
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
2 "http://www.w3.org/TR/html4/loose.dtd">
3 <html>
4 <head>
5   <title>What's New in this Release</title>
6   <meta name="GENERATOR" content="Modular DocBook HTML Stylesheet Version 1.79">
7   <link rel="HOME" title="Privoxy 3.0.33 User Manual" href="index.html">
8   <link rel="PREVIOUS" title="Installation" href="installation.html">
9   <link rel="NEXT" title="Quickstart to Using Privoxy" href="quickstart.html">
10   <link rel="STYLESHEET" type="text/css" href="../p_doc.css">
11   <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
12   <link rel="STYLESHEET" type="text/css" href="p_doc.css">
13 </head>
14 <body class="SECT1" bgcolor="#EEEEEE" text="#000000" link="#0000FF" vlink="#840084" alink="#0000FF">
15   <div class="NAVHEADER">
16     <table summary="Header navigation table" width="100%" border="0" cellpadding="0" cellspacing="0">
17       <tr>
18         <th colspan="3" align="center">Privoxy 3.0.33 User Manual</th>
19       </tr>
20       <tr>
21         <td width="10%" align="left" valign="bottom"><a href="installation.html" accesskey="P">Prev</a></td>
22         <td width="80%" align="center" valign="bottom"></td>
23         <td width="10%" align="right" valign="bottom"><a href="quickstart.html" accesskey="N">Next</a></td>
24       </tr>
25     </table>
26     <hr align="left" width="100%">
27   </div>
28   <div class="SECT1">
29     <h1 class="SECT1"><a name="WHATSNEW" id="WHATSNEW">3. What's New in this Release</a></h1>
30     <p><span class="APPLICATION">Privoxy 3.0.33</span> fixes an XSS issue and multiple DoS issues and a couple of other
31     bugs. The issues also affect earlier Privoxy releases. <span class="APPLICATION">Privoxy 3.0.33</span> also comes
32     with a couple of general improvements an new features.</p>
33     <p>Changes in <span class="APPLICATION">Privoxy 3.0.33</span> stable:</p>
34     <ul>
35       <li>
36         <p>Security/Reliability:</p>
37         <ul>
38           <li>
39             <p>cgi_error_no_template(): Encode the template name to prevent XSS (cross-side scripting) when Privoxy is
40             configured to servce the user-manual itself. Commit 0e668e9409c. OVE-20211102-0001. CVE-2021-44543.
41             Reported by: Artem Ivanov</p>
42           </li>
43           <li>
44             <p>get_url_spec_param(): Free memory of compiled pattern spec before bailing. Reported by Joshua Rogers
45             (Opera) who also provided the fix. Commit 652b4b7cb0. OVE-20211201-0003. CVE-2021-44540.</p>
46           </li>
47           <li>
48             <p>process_encrypted_request_headers(): Free header memory when failing to get the request destination.
49             Reported by Joshua Rogers (Opera) who also provided the fix. Commit 0509c58045. OVE-20211201-0002.
50             CVE-2021-44541.</p>
51           </li>
52           <li>
53             <p>send_http_request(): Prevent memory leaks when handling errors Reported by Joshua Rogers (Opera) who
54             also provided the fix. Commit c48d1d6d08. OVE-20211201-0001. CVE-2021-44542.</p>
55           </li>
56         </ul>
57       </li>
58       <li>
59         <p>Bug fixes:</p>
60         <ul>
61           <li>
62             <p>handle_established_connection(): Skip the poll()/select() calls if TLS data is pending on the server
63             socket. The TLS library may have already consumed all the data from the server response in which case
64             poll() and select() will not detect that data is available to be read. Fixes SF bug #926 reported by Wen
65             Yue.</p>
66           </li>
67           <li>
68             <p>continue_https_chat(): Update csp-&#62;server_connection.request_sent after sending the request to make
69             sure the latency is calculated correctly. Previously https connections were not reused after timeout
70             seconds after the first request made on the connection.</p>
71           </li>
72           <li>
73             <p>free_pattern_spec(): Don't try to free an invalid pointer when unloading an action file with a TAG
74             pattern while Privoxy has been compiled without FEATURE_PCRE_HOST_PATTERNS. Closes: SF patch request #147.
75             Patch by Maxim Antonov.</p>
76           </li>
77           <li>
78             <p>Adjust build_request_line() to create a CONNECT request line when https-inspecting and forwarding to a
79             HTTP proxy. Fixes SF bug #925 reported by Wen Yue.</p>
80           </li>
81           <li>
82             <p>load_config(): Add a space that was missing in a log message.</p>
83           </li>
84           <li>
85             <p>read_http_request_body(): Fix two error messages that used an incorrect variable.</p>
86           </li>
87           <li>
88             <p>If the the response is chunk-encoded, ignore the Content-Length header sent by the server. Allows to
89             load https://redmine.lighttpd.net/ with filtering enabled.</p>
90           </li>
91         </ul>
92       </li>
93       <li>
94         <p>General improvements:</p>
95         <ul>
96           <li>
97             <p>Allow to edit the add-header action through the CGI editor by generalizing the code that got added with
98             the suppress-tag action. Closes SF patch request #146. Patch by Maxim Antonov.</p>
99           </li>
100           <li>
101             <p>Add a CGI handler for /wpad.dat that returns a Proxy Auto-Configuration (PAC) file. Among other things,
102             it can be used to instruct clients through DHCP to use Privoxy as proxy. For example with the dnsmasq
103             option: dhcp-option=252,http://config.privoxy.org/wpad.dat Initial patch by Richard Schneidt.</p>
104           </li>
105           <li>
106             <p>Don't log the applied actions in process_encrypted_request() Log them in continue_https_chat() instead
107             to mirror chat(). Prevents the applied actions from getting logged twice for the first request on an
108             https-inspected connection.</p>
109           </li>
110           <li>
111             <p>OpenSSL generate_host_certificate(): Use config.privoxy.org as Common Name Org and Org Unit if the real
112             host name is too long to get accepted by OpenSSL. Clients should only care about the Subject Alternative
113             Name anyway and we can continue to use the real host name for it. Reported by Miles Wen on
114             privoxy-users@.</p>
115           </li>
116           <li>
117             <p>Establish the TLS connection with the client earlier and decide how to route the request afterwards.
118             This allows to change the forwarding settings based on information from the https-inspected request, for
119             example the path.</p>
120           </li>
121           <li>
122             <p>listen_loop(): When shutting down gracefully, close listening ports before waiting for the threads to
123             exit. Allows to start a second Privoxy with the same config file while the first Privoxy is still
124             running.</p>
125           </li>
126           <li>
127             <p>serve(): Close the client socket as well if the server socket for an inspected connection has been
128             closed. Privoxy currently can't establish a new server connection when the client socket is reused and
129             would drop the connection in continue_https_chat() anyway.</p>
130           </li>
131           <li>
132             <p>Don't disable redirect checkers in redirect_url(). Disable them in handle_established_connection()
133             instead. Doing it in redirect_url() prevented the +redirect{} and +fast-redirects{} actions from being
134             logged with LOG_LEVEL_ACTIONS.</p>
135           </li>
136           <li>
137             <p>handle_established_connection(): Slightly improve a comment.</p>
138           </li>
139           <li>
140             <p>handle_established_connection(): Fix a comment.</p>
141           </li>
142           <li>
143             <p>socks5_connect(): Fix indentation.</p>
144           </li>
145           <li>
146             <p>handle_established_connection(): Improve an error message.</p>
147           </li>
148           <li>
149             <p>create_pattern_spec(): Fix ifdef indentation.</p>
150           </li>
151           <li>
152             <p>Fix comment typos.</p>
153           </li>
154           <li>
155             <p>process_encrypted_request(): Improve a log message. The function only processes request headers and
156             there may still be unread request body data left to process.</p>
157           </li>
158           <li>
159             <p>chat(): Log the applied actions before deciding how to forward the request.</p>
160           </li>
161           <li>
162             <p>parse_time_header(): Silence a coverity complaint when building without assertions.</p>
163           </li>
164           <li>
165             <p>receive_encrypted_request_headers(): Improve a log message.</p>
166           </li>
167           <li>
168             <p>mbedTLS get_ciphersuites_from_string(): Use strlcpy() instead of strncpy(). Previously the terminating
169             NUL wasn't copied which resulted in a compiler warning. This didn't cause actual problems as the target
170             buffer was initialized by zalloc_or_die() so the last byte of the target buffer was NUL already. Actually
171             copying the terminating NUL seems clearer, though.</p>
172           </li>
173           <li>
174             <p>Remove compiler warnings. "log_error(LOG_LEVEL_FATAL, ..." doesn't return but apparently the compiler
175             doesn't know that. Get rid of several "this statement may fall through [-Wimplicit-fallthrough=]"
176             warnings.</p>
177           </li>
178           <li>
179             <p>Store the PEM certificate in a dynamically allocated buffer when https-inspecting. Should prevent errors
180             like: 2021-03-16 22:36:19.148 7f47bbfff700 Error: X509 PEM cert len 16694 is larger than buffer len 16383
181             As a bonus it should slightly reduce the memory usage as most certificates are smaller than the previously
182             used fixed buffer. Reported by: Wen Yue</p>
183           </li>
184           <li>
185             <p>OpenSSL generate_host_certificate(): Fix two error messsages.</p>
186           </li>
187           <li>
188             <p>Improve description of handle_established_connection()</p>
189           </li>
190           <li>
191             <p>OpenSSL ssl_store_cert(): Translate EVP_PKEY_EC to a string.</p>
192           </li>
193           <li>
194             <p>OpenSSL ssl_store_cert(): Remove pointless variable initialization.</p>
195           </li>
196           <li>
197             <p>OpenSSL ssl_store_cert(): Initialize pointer with NULL instead of 0.</p>
198           </li>
199         </ul>
200       </li>
201       <li>
202         <p>Action file improvements:</p>
203         <ul>
204           <li>
205             <p>Disable fast-redirects for .microsoftonline.com/.</p>
206           </li>
207           <li>
208             <p>Disable fast-redirects for idp.springer.com/.</p>
209           </li>
210           <li>
211             <p>Disable fast-redirects for .zeit.de/zustimmung.</p>
212           </li>
213           <li>
214             <p>Unblock adv-archiv.dfn-cert.de/.</p>
215           </li>
216           <li>
217             <p>Block requests to eu-tlp01.kameleoon.eu/.</p>
218           </li>
219           <li>
220             <p>Block requests to fpa-events.arstechnica.com/.</p>
221           </li>
222           <li>
223             <p>Unblock nlnet.nl/.</p>
224           </li>
225           <li>
226             <p>Unblock adguard.com/.</p>
227           </li>
228         </ul>
229       </li>
230       <li>
231         <p>Privoxy-Log-Parser:</p>
232         <ul>
233           <li>
234             <p>Highlight 'Socket timeout 3 reached: http://127.0.0.1:20000/no-filter/chunked-content/36'.</p>
235           </li>
236           <li>
237             <p>Improve documentation for inactivity-detection mode.</p>
238           </li>
239           <li>
240             <p>Detect date changes when looking for inactivity.</p>
241           </li>
242           <li>
243             <p>Add a --passed-request-statistics-threshold option that can be set to get statistics for requests that
244             were passed.</p>
245           </li>
246           <li>
247             <p>Add a "inactivity detection" mode which can be useful for debugging purposes.</p>
248           </li>
249           <li>
250             <p>Bump version to 0.9.4.</p>
251           </li>
252           <li>
253             <p>Only run print_intro() and print_outro() when syntax highlighting.</p>
254           </li>
255           <li>
256             <p>Rephrase a sentence in the documentation.</p>
257           </li>
258           <li>
259             <p>Highlight 'Client socket 7 is no longer usable. The server socket has been closed.'.</p>
260           </li>
261           <li>
262             <p>Clarify --statistics output by explicitly mentioning that the status codes sent by the server may differ
263             from the ones in "debug 512" messages.</p>
264           </li>
265           <li>
266             <p>Fix typo in the --statistics output.</p>
267           </li>
268           <li>
269             <p>Remove an unused variable.</p>
270           </li>
271           <li>
272             <p>Highlight 'The peer notified us that the connection on socket 11 is going to be closed'.</p>
273           </li>
274         </ul>
275       </li>
276       <li>
277         <p>Privoxy-Regression-Test:</p>
278         <ul>
279           <li>
280             <p>Remove duplicated word in a comment.</p>
281           </li>
282         </ul>
283       </li>
284       <li>
285         <p>regression-tests.action:</p>
286         <ul>
287           <li>
288             <p>Add fetch test for http://p.p/wpad.dat.</p>
289           </li>
290           <li>
291             <p>Bump for-privoxy-version to 3.0.33 which introduced the wpad.dat support.</p>
292           </li>
293           <li>
294             <p>Add more tests for the '/send-banner' code.</p>
295           </li>
296           <li>
297             <p>Add test for OVE-20210203-0001.</p>
298           </li>
299           <li>
300             <p>Add a test for CVE-2021-20217.</p>
301           </li>
302         </ul>
303       </li>
304       <li>
305         <p>uagen:</p>
306         <ul>
307           <li>
308             <p>Bump generated Firefox version to 91 (ESR).</p>
309           </li>
310           <li>
311             <p>Bump version to 1.2.3.</p>
312           </li>
313           <li>
314             <p>Bump copyright.</p>
315           </li>
316         </ul>
317       </li>
318       <li>
319         <p>Build system:</p>
320         <ul>
321           <li>
322             <p>configure: Bump SOURCE_DATE_EPOCH.</p>
323           </li>
324           <li>
325             <p>GNUmakefile.in: Fix typo.</p>
326           </li>
327           <li>
328             <p>configure: Add another warning in case --disable-pthread is used while POSIX threads are available.
329             Various features don't even compile when not using threads.</p>
330           </li>
331           <li>
332             <p>Add configure option to enable MemorySanitizer.</p>
333           </li>
334           <li>
335             <p>Add configure option to enable UndefinedBehaviorSanitizer.</p>
336           </li>
337           <li>
338             <p>Add configure option to enable AddressSanitizer.</p>
339           </li>
340           <li>
341             <p>Bump copyright.</p>
342           </li>
343           <li>
344             <p>Add a configure option to disable pcre JIT compilation. While JIT compilation makes filtering faster it
345             can cause false-positive valgrind complaints. As reported by Gwyn Ciesla in SF bug 924 it also can cause
346             problems when the SELinux policy does not grant Privoxy "execmem" privileges.</p>
347           </li>
348           <li>
349             <p>configure: Remove obsolete RPM_BASE check.</p>
350           </li>
351         </ul>
352       </li>
353       <li>
354         <p>Windows build system:</p>
355         <ul>
356           <li>
357             <p>Update the build script to use mbed tls version 2.6.11.</p>
358           </li>
359           <li>
360             <p>Update build script to use the final 8.45 pcre library.</p>
361           </li>
362           <li>
363             <p>Put all the '--enable-xxx' options in the configure call together.</p>
364           </li>
365         </ul>
366       </li>
367       <li>
368         <p>macOS build system:</p>
369         <ul>
370           <li>
371             <p>The OSXPackageBuilder repository has been updated and can be used to create macOS packages again.</p>
372           </li>
373         </ul>
374       </li>
375       <li>
376         <p>Documentation:</p>
377         <ul>
378           <li>
379             <p>contacting: Remove obsolete reference to announce.sgml.</p>
380           </li>
381           <li>
382             <p>contacting: Request that the browser cache is cleared before producing a log file for submission.</p>
383           </li>
384           <li>
385             <p>Sponsor FAQ: Note that Privoxy users may follow sponsor links without Referer header set.</p>
386           </li>
387           <li>
388             <p>newfeatures: Clarify that https inspection also allows to filter https responses.</p>
389           </li>
390           <li>
391             <p>developer-manual: Mention that announce.txt should be updated when doing a release.</p>
392           </li>
393           <li>
394             <p>config: Explicitly mention that the CGI pages disclosing the ca-password can be blocked and upgrade the
395             disclosure paragraphs to a warning.</p>
396           </li>
397           <li>
398             <p>Put all the requested debug options in the config file. Section 11.1 of the Privoxy user manual lists
399             all the debug options that should be enabled when reporting problems or requesting support. Make it easier
400             for users to do the right thing by having all those options present in the config.</p>
401           </li>
402           <li>
403             <p>Update TODO list item #184 to note that WolfSSL support will (hopefully) appear after the 3.0.34
404             release.</p>
405           </li>
406           <li>
407             <p>Update max-client-connections's description. On modern systems other than Windows Privoxy should use
408             poll() in which case the FD_SETSIZE value isn't releveant.</p>
409           </li>
410           <li>
411             <p>Add a warning that the socket-timeout does not apply to operations done by TLS libraries.</p>
412           </li>
413           <li>
414             <p>Make documentation slightly less "offensive" for some people by avoiding the word "hell".</p>
415           </li>
416         </ul>
417       </li>
418     </ul>
419     <div class="SECT2">
420       <h2 class="SECT2"><a name="UPGRADERSNOTE" id="UPGRADERSNOTE">3.1. Note to Upgraders</a></h2>
421       <p>A quick list of things to be aware of before upgrading from earlier versions of <span class=
422       "APPLICATION">Privoxy</span>:</p>
423       <ul>
424         <li>
425           <p>The recommended way to upgrade <span class="APPLICATION">Privoxy</span> is to backup your old
426           configuration files, install the new ones, verify that <span class="APPLICATION">Privoxy</span> is working
427           correctly and finally merge back your changes using <span class="APPLICATION">diff</span> and maybe
428           <span class="APPLICATION">patch</span>.</p>
429           <p>There are a number of new features in each <span class="APPLICATION">Privoxy</span> release and most of
430           them have to be explicitly enabled in the configuration files. Old configuration files obviously don't do
431           that and due to syntax changes using old configuration files with a new <span class=
432           "APPLICATION">Privoxy</span> isn't always possible anyway.</p>
433         </li>
434         <li>
435           <p>Note that some installers remove earlier versions completely, including configuration files, therefore you
436           should really save any important configuration files!</p>
437         </li>
438         <li>
439           <p>On the other hand, other installers don't overwrite existing configuration files, thinking you will want
440           to do that yourself.</p>
441         </li>
442         <li>
443           <p>In the default configuration only fatal errors are logged now. You can change that in the <a href=
444           "config.html#DEBUG">debug section</a> of the configuration file. You may also want to enable more verbose
445           logging until you verified that the new <span class="APPLICATION">Privoxy</span> version is working as
446           expected.</p>
447         </li>
448         <li>
449           <p>Three other config file settings are now off by default: <a href=
450           "config.html#ENABLE-REMOTE-TOGGLE">enable-remote-toggle</a>, <a href=
451           "config.html#ENABLE-REMOTE-HTTP-TOGGLE">enable-remote-http-toggle</a>, and <a href=
452           "config.html#ENABLE-EDIT-ACTIONS">enable-edit-actions</a>. If you use or want these, you will need to
453           explicitly enable them, and be aware of the security issues involved.</p>
454         </li>
455       </ul>
456     </div>
457   </div>
458   <div class="NAVFOOTER">
459     <hr align="left" width="100%">
460     <table summary="Footer navigation table" width="100%" border="0" cellpadding="0" cellspacing="0">
461       <tr>
462         <td width="33%" align="left" valign="top"><a href="installation.html" accesskey="P">Prev</a></td>
463         <td width="34%" align="center" valign="top"><a href="index.html" accesskey="H">Home</a></td>
464         <td width="33%" align="right" valign="top"><a href="quickstart.html" accesskey="N">Next</a></td>
465       </tr>
466       <tr>
467         <td width="33%" align="left" valign="top">Installation</td>
468         <td width="34%" align="center" valign="top">&nbsp;</td>
469         <td width="33%" align="right" valign="top">Quickstart to Using Privoxy</td>
470       </tr>
471     </table>
472   </div>
473 </body>
474 </html>