dotnet / dotnet-api-docs

.NET API reference documentation (.NET 5+, .NET Core, .NET Framework)
https://docs.microsoft.com/dotnet/api/
Other
725 stars 1.56k forks source link

Unclear what SslCertificateTrust is referring to #10504

Closed fh-yuxiao-zeng closed 3 weeks ago

fh-yuxiao-zeng commented 3 weeks ago

Type of issue

Typo

Description

The document says "Gets or sets an optional customized policy for remote certificate validation. If not null, CertificateRevocationCheckMode and SslCertificateTrust are ignored."

CertificateRevocationCheckMode is another property in the SslClientAuthenticationOptions class, so it makes a lot of sense. On the other hand, SslCertificateTrust is a class. It's not clear what it means by a class is ignored. I was expecting a property.

(Should it be ClientCertificateContext?)

Page URL

https://learn.microsoft.com/en-us/dotnet/api/system.net.security.sslclientauthenticationoptions.certificatechainpolicy?view=net-8.0#system-net-security-sslclientauthenticationoptions-certificatechainpolicy

Content source URL

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

Document Version Independent Id

01385e9b-4f99-408d-1840-6a7f6f0103b5

Article author

@karelz

dotnet-policy-service[bot] commented 3 weeks ago

Tagging subscribers to this area: @dotnet/ncl

rzikm commented 3 weeks ago

it refers to SslStreamCertificateContext 's (the (Client/Server)CertificateContext property) Trust property, the wording can definitely use some improvements.