dotnet/Documentation/compatibility/sslstream-support-for-tls-a...

2.5 KiB

SslStream supports TLS Alerts

Scope

Edge

Version Introduced

4.7

Source Analyzer Status

NotPlanned

Change Description

After a failed TLS handshake, an IOException with an inner Win32Exception exception will be thrown by the first I/O Read/Write operation. The NativeErrorCode code for the Win32Exception can be mapped to the TLS Alert from the remote party using this Schannel documentation.

For more information, see RFC 2246: Section 7.2.2 Error alerts

The behavior in .NET 4.6.2 and below is that the transport channel (usually TCP connection) will timeout during either Write or Read if the other party failed the handshake and immediately afterwards rejected the connection.

  • Quirked
  • Build-time break

Applications calling network I/O APIs such as Stream.Read/Stream.Write should handle IOException or TimeoutException.

The TLS Alerts feature is enabled by default starting with .NET 4.7. Applications targeting .NET 4.0 - .NET 4.6.2 running on a .NET 4.7 or higher system will have the feature disabled to preserve compatibility.

The following configuration API is available to enable or disable the feature for .NET 4.6 and above applications running on .NET 4.7 or higher framework.

  • Programmatically:

    Must be the very first thing the application does since ServicePointManager will initialize only once:  

    AppContext.SetSwitch("TestSwitch.LocalAppContext.DisableCaching", true);
    AppContext.SetSwitch("Switch.System.Net.DontEnableTlsAlerts", true); // Set to 'false' to enable the feature in .NET 4.6 - 4.6.2.
  • AppConfig:
		<runtime>
			<AppContextSwitchOverrides value="Switch.System.Net.DontEnableTlsAlerts=true"/>
			<!-- Set to 'false' to enable the feature in .NET 4.6 - 4.6.2. -->
		</runtime>
  • Registry key (machine global):

    Set the Value to 'false' to enable the feature in .NET 4.6 - 4.6.2.

			Key = HKLM\SOFTWARE\[Wow6432Node\]Microsoft\.NETFramework\AppContext\Switch.System.Net.DontEnableTlsAlerts
			Type = String
			Value = "true"

Affected APIs

  • T:System.Net.Security.SslStream
  • T:System.Net.WebRequest
  • T:System.Net.HttpWebRequest
  • T:System.Net.FtpWebRequest
  • T:System.Net.Mail.SmtpClient
  • N:System.Net.Http

Category

Networking, Security