dotnet / dotnet/dotnet-api-docs

SslStream AuthenticateAsClient override with SslProtocols incorrectly says that the method authenticates with None

Open
#10,671 4 comments 0 reactions 0 assignees View on GitHub
area-System.Net.Security Pri3 untriaged
Dominant language
C#
Stars
949
Forks
1.7k
Avg merge
3d 27m
Merged PRs (30d)
49

Description

### Type of issue

Other (describe below)

### Description

In the Remarks section of the SslStream.AuthenticateAsClient (last override - including the enabledSslProtocols parameter) there is the following:

Starting with .NET Framework 4.7, this method authenticates using [None](https://learn.microsoft.com/en-us/dotnet/api/system.security.authentication.sslprotocols?view=net-8.0#system-security-authentication-sslprotocols-none), which allows the operating system to choose the best protocol to use, and to block protocols that are not secure. In .NET Framework 4.6 (and .NET Framework 4.5 with the latest security patches installed), the allowed TLS/SSL protocols versions are 1.2, 1.1, and 1.0 (unless you disable strong cryptography by editing the Windows Registry).

This appears to be a cut and paste from the first 3 overrides which do NOT include the enabledSslProtocols parameter. The statement is incorrect in that this override authenticates using the value of the enabledSslProtocols - NOT the value SslProtocols.None.
[Enter feedback here]

### Page URL

https://learn.microsoft.com/en-us/dotnet/api/system.net.security.sslstream.authenticateasclient?view=net-8.0

### Content source URL

https://github.com/dotnet/dotnet-api-docs/blob/main/xml/System.Net.Security/SslStream.xml

### Document Version Independent Id

539931f5-83fa-16f5-0f22-201c5fa3cc33

### Article author

@karelz

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.