Cleanup: fix most 'unused parameter' warnings

[thirdparty/squid.git] / doc / release-notes / release-3.6.sgml

<!doctype linuxdoc system>
<article>
<title>Squid 3.6.0.0 release notes</title>
<author>Squid Developers</author>

<abstract>
This document contains the release notes for version 3.6 of Squid.
Squid is a WWW Cache application developed by the National Laboratory
for Applied Network Research and members of the Web Caching community.
</abstract>

<toc>

<sect>Notice
<p>
The Squid Team are pleased to announce the release of Squid-3.6.0.0 for testing.

This new release is available for download from <url url="http://www.squid-cache.org/Versions/v3/3.6/"> or the
 <url url="http://www.squid-cache.org/Mirrors/http-mirrors.html" name="mirrors">.

<p>While this release is not deemed ready for production use, we believe it is ready for wider testing by the community.

<p>We welcome feedback and bug reports. If you find a bug, please see <url url="http://wiki.squid-cache.org/SquidFaq/BugReporting">
   for how to submit a report with a stack trace.

<sect1>Known issues
<p>
Although this release is deemed good enough for use in many setups, please note the existence of 
<url url="http://bugs.squid-cache.org/buglist.cgi?query_format=advanced&amp;product=Squid&amp;bug_status=UNCONFIRMED&amp;bug_status=NEW&amp;bug_status=ASSIGNED&amp;bug_status=REOPENED&amp;version=3.6" name="open bugs against Squid-3.6">.

<sect1>Changes since earlier releases of Squid-3.6
<p>
The 3.6 change history can be <url url="http://www.squid-cache.org/Versions/v3/3.6/changesets/" name="viewed here">.


<sect>Major new features since Squid-3.5
<p>Squid 3.6 represents a new feature release above 3.5.

<p>The most important of these new features are:
<itemize>
	<item>Helper concurrency channels changes
	<item>Configurable helper queue size
	<item>SSLv2 support removal
	<item>MSNT Helper changes
</itemize>

Most user-facing changes are reflected in squid.conf (see below).


<sect1>Configurable helper queue size
<p>The new queue-size=N option to helpers configuration, allows users 
to configure the maximum number of queued requests to busy helpers.

<sect1>Helper concurrency channels changes
<p> helper-mux.pl we have been distributing for the past few years to
    encourage use of concurrency is no longer compatible with Squid. If
    used it will spawn up to 2^64 helpers and DoS the Squid server.

<p> Helpers utilizing arrays to handle fixed amounts of concurrency
    channels MUST be re-written to use queues and capable of handling a
    64-bit int as index or they will be vulnerable to buffer overrun and
    arbitrary memory accesses.

<p> 32-bit helpers need re-writing to handle the concurrency channel ID
    as a 64-bit integer value. If not updated they will cause proxies to
    return unexpected results or timeout once crossing the 32-bit wrap
    boundary. Leading to undefined behaviour in the client HTTP traffic.

<sect1>SSLv2 support removal
<p>Details in <url url="https://tools.ietf.org/html/rfc6176" name="RFC 6176">

<p>SSLv2 is not fit for purpose. Squid no longer supports being configured with
any settings regarding this protocol. That includes settings manually disabling
its use since it is now forced to disable by default. Also settings enabling
various client/server workarounds specific to SSLv2 are removed.


<sect1>MSNT Helper changes

<p>The authentication helper previously known as <em>basic_msnt_auth</em> has
   been renamed to <em>basic_smb_lm_auth</em> to reflect that it only performs
   SMB LanMan protocol(s) instead of modern ActiveDirectory protocols.

<p>The <em>basic_smb_lm_auth</em> helper is also deprecated and will be removed
   in a later Squid version.

<p>The <em>basic_msnt_multi_domain_auth</em> helper has been removed. The
   <em>basic_smb_lm_auth</em> helper performs the same actions without extra
   Perl and Samba dependencies.


<sect>Changes to squid.conf since Squid-3.5
<p>
There have been changes to Squid's configuration file since Squid-3.5.

This section gives a thorough account of those changes in three categories:

<itemize>
	<item><ref id="newtags" name="New tags">
	<item><ref id="modifiedtags" name="Changes to existing tags">
	<item><ref id="removedtags" name="Removed tags">
</itemize>
<p>

<sect1>New tags<label id="newtags">
<p>
<descrip>
         <tag> url_rewrite_timeout </tag>
         <p> Squid times active requests to redirector. This option sets
             the timeout value and the Squid reaction to a timed out
             request. </p>
</descrip>

<sect1>Changes to existing tags<label id="modifiedtags">
<p>
<descrip>
	<tag>auth_param</tag>
	<p>New parameter <em>queue-size=</em> to set the maximum number
	   of queued requests.

	<tag>cache_peer</tag>
	<p>All <em>ssloption=</em> and <em>sslversion=</em> values for
	   SSLv2 configuration or disabling have been removed.
	<p>Manual squid.conf update may be required on upgrade.

	<tag>external_acl_type<tag>
	<p>New parameter <em>queue-size=</em> to set the maximum number
	   of queued requests.

	<tag>http_port</tag>
	<p>All <em>version=</em> <em>option=</em> values for SSLv2
	   configuration or disabling have been removed.
	<p>Manual squid.conf update may be required on upgrade.

	<tag>https_port</tag>
	<p>All <em>version=</em> <em>option=</em> values for SSLv2
	   configuration or disabling have been removed.
	<p>Manual squid.conf update may be required on upgrade.

	<tag>sslcrtd_children</tag>
	<p>New parameter <em>queue-size=</em> to set the maximum number
	   of queued requests.

	<tag>sslcrtvalidator_children</tag>
	<p>New parameter <em>queue-size=</em> to set the maximum number
	   of queued requests.

	<tag>sslproxy_options</tag>
	<p>All values for SSLv2 configuration or disabling have been removed.
	<p>Manual squid.conf update may be required on upgrade.

	<tag>sslproxy_version</tag>
	<p>Value '2' for SSLv2-only operation is no longer supported.

	<tag>url_rewrite_children<tag>
	<p>New parameter <em>queue-size=</em> to set the maximum number
	   of queued requests.

</descrip>

<sect1>Removed tags<label id="removedtags">
<p>
<descrip>

</descrip>


<sect>Changes to ./configure options since Squid-3.5
<p>
There have been some changes to Squid's build configuration since Squid-3.5.

This section gives an account of those changes in three categories:

<itemize>
	<item><ref id="newoptions" name="New options">
	<item><ref id="modifiedoptions" name="Changes to existing options">
	<item><ref id="removedoptions" name="Removed options">
</itemize>


<sect1>New options<label id="newoptions">
<p>
<descrip>

</descrip>

<sect1>Changes to existing options<label id="modifiedoptions">
<p>
<descrip>

</descrip>
</p>

<sect1>Removed options<label id="removedoptions">
<p>
<descrip>

</descrip>


<sect>Regressions since Squid-2.7

<p>Some squid.conf options which were available in Squid-2.7 are not yet available in Squid-3.6

<p>If you need something to do then porting one of these from Squid-2 to Squid-3 is most welcome.

<sect1>Missing squid.conf options available in Squid-2.7
<p>
<descrip>
	<tag>broken_vary_encoding</tag>
	<p>Not yet ported from 2.6

	<tag>cache_peer</tag>
	<p><em>monitorinterval=</em> not yet ported from 2.6
	<p><em>monitorsize=</em> not yet ported from 2.6
	<p><em>monitortimeout=</em> not yet ported from 2.6
	<p><em>monitorurl=</em> not yet ported from 2.6

	<tag>cache_vary</tag>
	<p>Not yet ported from 2.6

	<tag>error_map</tag>
	<p>Not yet ported from 2.6

	<tag>external_refresh_check</tag>
	<p>Not yet ported from 2.7

	<tag>location_rewrite_access</tag>
	<p>Not yet ported from 2.6

	<tag>location_rewrite_children</tag>
	<p>Not yet ported from 2.6

	<tag>location_rewrite_concurrency</tag>
	<p>Not yet ported from 2.6

	<tag>location_rewrite_program</tag>
	<p>Not yet ported from 2.6

	<tag>refresh_pattern</tag>
	<p><em>stale-while-revalidate=</em> not yet ported from 2.7
	<p><em>ignore-stale-while-revalidate=</em> not yet ported from 2.7
	<p><em>negative-ttl=</em> not yet ported from 2.7

	<tag>refresh_stale_hit</tag>
	<p>Not yet ported from 2.7

	<tag>update_headers</tag>
	<p>Not yet ported from 2.7

</descrip>

<sect>Copyright
<p>
Copyright (C) 1996-2014 The Squid Software Foundation and contributors
<p>
Squid software is distributed under GPLv2+ license and includes
contributions from numerous individuals and organizations.
Please see the COPYING and CONTRIBUTORS files for details.

</article>