Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update docs for SslCertificateTrust with changes in .NET 7 #7832

Merged
merged 3 commits into from
Mar 18, 2022
Merged

Update docs for SslCertificateTrust with changes in .NET 7 #7832

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
98666df
Update docs for SslCertificateTrust with changes in .NET 7
rzikm Mar 16, 2022
578c295
Fix build errors
rzikm Mar 16, 2022
19cfb62
Fix wording
rzikm Mar 16, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 10 additions & 2 deletions xml/System.Net.Security/SslCertificateTrust.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,13 +55,18 @@

## Remarks

If the `sendTrustInHandshake` argument is `true`, the client can use the list of trusted certificate authorities from the server to select an appropriate client certificate. In .NET 6, the list is only sent on Windows, and it depends on a registry setting.
If the `sendTrustInHandshake` argument is `true`, the client can use the list of trusted certificate authorities from the server to select an appropriate client certificate. Sending trusted issuers list is not supported for `SslCertificateTrust` instances created using the `SslCertificaetTrust.CreateForX509Collection` in .NET 6.

Since .NET 7, the sending trusted issuers list is supported on Linux and OSX platforms.

> [!WARNING]
> The list of trusted CAs increases the size of the handshake message. It could also be viewed as an information leak about the system's configuration. For these reasons, we recommend setting `sendTrustInHandshake` to `false`.

]]></format>
</remarks>
<exception cref="T:System.PlatformNotSupportedException">
<paramref name="sendTrustInHandshake" /> is <see langword="true" /> and the current platform does not support sending trusted issuers list in handshake.
</exception>
</Docs>
</Member>
<Member MemberName="CreateForX509Store">
Expand Down Expand Up @@ -94,13 +99,16 @@ If the `sendTrustInHandshake` argument is `true`, the client can use the list of

## Remarks

If the `sendTrustInHandshake` argument is `true`, the client can use the list of trusted certificate authorities from the server to select an appropriate client certificate. In .NET 6, the list is only sent on Windows, and it depends on a registry setting.
If the `sendTrustInHandshake` argument is `true`, the client can use the list of trusted certificate authorities from the server to select an appropriate client certificate. In .NET 6, the list is only sent on Windows, and it depends on the "HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\SecurityProviders\SCHANNEL\SendTrustedIssuerList" registry setting being set to 1. Since .NET 7, the list is sent on Linux and OSX platforms as well.

> [!WARNING]
> The list of trusted CAs increases the size of the handshake message. It could also be viewed as an information leak about the system's configuration. For these reasons, we recommend setting `sendTrustInHandshake` to `false`.

]]></format>
</remarks>
<exception cref="T:System.PlatformNotSupportedException">
<paramref name="sendTrustInHandshake" /> is <see langword="true" /> and the current platform does not support sending trusted issuers list in handshake, or (on Windows) the <paramref name="store" />'s location is not <see cref="T:System.Security.Cryptography.X509Certificates.StoreLocation.LocalMachine" />.
</exception>
</Docs>
</Member>
</Members>
Expand Down