Skip to content

SslClientAuthenticationOptions - update documentation #4366

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

Merged
aik-jahoda merged 18 commits into from
Jul 7, 2020
Merged

SslClientAuthenticationOptions - update documentation #4366

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
18 commits
Select commit Hold shift + click to select a range
cf1d834
NegotiateStream - update documentation
Jun 11, 2020
0ffda34
Fix revocation mode
Jun 11, 2020
99581cb
Fix see reference
Jun 11, 2020
8d2b854
Merge remote-tracking branch 'upstream/master' into jajahoda/SslClien…
Jun 15, 2020
25eb59e
minor changes
Jun 15, 2020
5cc0dcf
Fix reference in class description
Jun 16, 2020
d446a81
Merge remote-tracking branch 'upstream/master' into jajahoda/SslClien…
Jun 17, 2020
c35002c
Apply PR comments
Jun 17, 2020
b36de79
fix closing tag
Jun 17, 2020
2c69b7b
apply review comments
Jun 17, 2020
3ef98fd
Update xml/System.Net.Security/SslClientAuthenticationOptions.xml
aik-jahoda Jun 18, 2020
b11bee9
Remove wrong ApplicationProtocols description
Jun 18, 2020
7bc90c3
Merge branch 'jajahoda/SslClientAuthenticationOptions' of github.com:…
Jun 18, 2020
24efcc0
Merge remote-tracking branch 'upstream/master' into jajahoda/SslClien…
Jun 26, 2020
73302ac
RP comments
Jun 26, 2020
bfb27e2
RP comments
Jun 26, 2020
32765db
Apply suggestions from code review
aik-jahoda Jul 7, 2020
00b4c06
Fix remark is not visible
Jul 7, 2020
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
64 changes: 46 additions & 18 deletions xml/System.Net.Security/SslClientAuthenticationOptions.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,17 @@
</Base>
<Interfaces />
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<summary>Represents a client authentication property bag for the <see cref="T:System.Net.Security.SslStream" />.</summary>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks
This property bag is used as argument for <xref:System.Net.Security.SslStream.AuthenticateAsClientAsync%2A> and, in .NET 5.0 and later versions, for <xref:System.Net.Security.SslStream.AuthenticateAsClient%2A>.

The <xref:System.Net.Http.SocketsHttpHandler> uses this property bag in the <xref: System.Net.Http.SocketsHttpHandler.SslOptions%2A> property.

]]></format>
</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
Expand All @@ -46,7 +55,7 @@
</AssemblyInfo>
<Parameters />
<Docs>
<summary>To be added.</summary>
<summary>Initializes a new instance of the <see cref="T:System.Net.Security.SslClientAuthenticationOptions" /> class.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand All @@ -72,8 +81,8 @@
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<summary>Gets or sets a value that indicates whether the <see cref="T:System.Net.Security.SslStream" /> should allow SSL renegotiation.</summary>
<value><see langword="true" /> to indicate that the <see cref="T:System.Net.Security.SslStream" /> allows SSL renegotiation; otherwise, <see langword="false" />. The default value is <see langword="true" />.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand All @@ -99,7 +108,7 @@
<ReturnType>System.Collections.Generic.List&lt;System.Net.Security.SslApplicationProtocol&gt;</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>Gets or sets a list of ALPN protocols.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
Expand All @@ -126,9 +135,20 @@
<ReturnType>System.Security.Cryptography.X509Certificates.X509RevocationMode</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<summary>Gets or sets the certificate revocation mode for certificate validation.</summary>
<value>One of the values in <see cref="T:System.Security.Cryptography.X509Certificates.X509RevocationMode" />: <see langword="NoCheck" />, <see langword="Online" />, or <see langword="Offline" />. The default is <see langword="Online" />.</value>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks
When using certificates, the system validates that the client certificate is not revoked by checking that the client certificate is not in the revoked certificate list. This validation can be performed by checking online or against a cached revocation list. You can trun off revocation checking by setting this property to <xref:System.Security.Cryptography.X509Certificates.X509RevocationMode.NoCheck>.

For more information, see [Working with Certificates](/dotnet/framework/wcf/feature-details/working-with-certificates).

]]></format>
</remarks>
<exception cref="T:System.ArgumentNullException">
The value contains an invalid enumeration value.</exception>
</Docs>
</Member>
<Member MemberName="CipherSuitesPolicy">
Expand Down Expand Up @@ -179,9 +199,17 @@
<ReturnType>System.Security.Cryptography.X509Certificates.X509CertificateCollection</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>A collection of certificates to be considered for the client's authentication to the server.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks

<xref:System.Net.Security.LocalCertificateSelectionCallback> can be used to select a specific certificate to offer to the server.

]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="EnabledSslProtocols">
Expand All @@ -206,8 +234,8 @@
<ReturnType>System.Security.Authentication.SslProtocols</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<summary>Gets or sets the value that represents the protocol versions offered by the client to the server during authentication.</summary>
<value>The default value is <see cref="F:System.Security.Authentication.SslProtocols.None" />, which is the recommended value. For more information, see <see cref="T:System.Security.Authentication.SslProtocols" />.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand All @@ -233,8 +261,8 @@
<ReturnType>System.Net.Security.EncryptionPolicy</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<summary>Gets or sets the encryption policy.</summary>
<value>The default value is <see cref="F:System.Net.Security.EncryptionPolicy.RequireEncryption" />.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand All @@ -260,7 +288,7 @@
<ReturnType>System.Net.Security.LocalCertificateSelectionCallback</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>Gets or sets a <see cref="T:System.Net.Security.LocalCertificateSelectionCallback" /> delegate that's responsible for selecting the client authentication certificate used for authentication.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
Expand All @@ -287,7 +315,7 @@
<ReturnType>System.Net.Security.RemoteCertificateValidationCallback</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>Gets or sets a <see cref="T:System.Net.Security.RemoteCertificateValidationCallback" /> delegate that's responsible for validating the certificate supplied by the remote party.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
Expand All @@ -314,7 +342,7 @@
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>Gets or sets the name of the server the client is trying to connect to. That name is used for server certificate validation. It can be a DNS name or an IP address.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
Expand Down
2 changes: 1 addition & 1 deletion xml/System.Net.Security/SslServerAuthenticationOptions.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -225,7 +225,7 @@
<ReturnType>System.Security.Authentication.SslProtocols</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the <see cref="T:System.Security.Authentication.SslProtocols" /> value that represents protocols used for authentication.</summary>
<summary>Gets or sets a value that represents protocol versions used by the server to match the client protocol version during authentication.</summary>
<value>The default value is <see cref="F:System.Security.Authentication.SslProtocols.None" />, which is the recommended value. See <see cref="T:System.Security.Authentication.SslProtocols" /> for more details.</value>
<remarks>To be added.</remarks>
</Docs>
Expand Down