Skip to content

SslServerAuthenticationOptions - update documentation #4367

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
merged 14 commits into from
Jun 18, 2020
Merged

SslServerAuthenticationOptions - update documentation #4367

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
a4a1c55
SslServerAuthenticationOptions - update documentation
Jun 11, 2020
119b696
Fix see reference
Jun 11, 2020
8239f0d
apply PR comments
Jun 15, 2020
64fdfc0
Merge remote-tracking branch 'upstream/master' into jajahoda/SslServe…
Jun 15, 2020
229a81d
apply PR comments
Jun 15, 2020
e76b2cf
Merge remote-tracking branch 'upstream/master' into jajahoda/SslServe…
Jun 17, 2020
c6e118f
Extend sslApplicationProtocol remark
Jun 17, 2020
8887daa
add default value for ApplicationProtocols
Jun 17, 2020
02648a0
fix closing tag
Jun 17, 2020
f3c6625
fix closing tag
Jun 17, 2020
a530e18
apply review commevts
Jun 17, 2020
9921593
Apply PR comments
Jun 18, 2020
7d43391
remove an article
Jun 18, 2020
27ea1db
remove an article
Jun 18, 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
Prev Previous commit
Next Next commit
apply PR comments
  • Loading branch information
Jan Jahoda committed Jun 15, 2020
commit 8239f0d6b5b5f54781e928f13ba7aa8e56311260
6 changes: 3 additions & 3 deletions xml/System.Net.Security/SslServerAuthenticationOptions.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
<format type="text/markdown"><![CDATA[

## Remarks
This property bag is used as argument for <xref:System.Net.Security.SslStream.AuthenticateAsServer%2A>, or <xref:System.Net.Security.SslStream.BeginAuthenticateAsServer%2A>.
This property bag is used as argument for <xref:System.Net.Security.SslStream.AuthenticateAsServer%2A>, or <xref:System.Net.Security.SslStream.AuthenticateAsServerAsync%2A>.

]]></format>
</remarks>
Expand Down Expand Up @@ -224,7 +224,7 @@
<ReturnType>System.Security.Authentication.SslProtocols</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the <see cref="T:System.Security.Authentication.SslProtocols" /> value that represents the protocol used for authentication.</summary>
<summary>Gets or sets the <see cref="T:System.Security.Authentication.SslProtocols" /> value that represents protocols used for authentication.</summary>
<value>The default value is <see cref="F:System.Security.Authentication.SslProtocols.None" /></value>
<remarks>To be added.</remarks>
</Docs>
Expand Down Expand Up @@ -280,7 +280,7 @@
<ReturnType>System.Net.Security.RemoteCertificateValidationCallback</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets a <see cref="T:System.Net.Security.RemoteCertificateValidationCallback" /> delegate responsible for validating the certificate supplied by the remote party.</summary>
<summary>Gets or sets a <see cref="T:System.Net.Security.RemoteCertificateValidationCallback" /> delegate responsible for custom validating the certificate supplied by the remote party.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
Expand Down
14 changes: 7 additions & 7 deletions xml/System.Net.Security/SslStream.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -668,7 +668,7 @@
<Docs>
<param name="targetHost">The name of the server that will share this <see cref="T:System.Net.Security.SslStream" />.</param>
<param name="clientCertificates">The <see cref="T:System.Security.Cryptography.X509Certificates.X509CertificateCollection" /> that contains client certificates.</param>
<param name="enabledSslProtocols">The <see cref="T:System.Security.Authentication.SslProtocols" /> value that represents the protocol used for authentication.</param>
<param name="enabledSslProtocols">The <see cref="T:System.Security.Authentication.SslProtocols" /> value that represents protocols used for authentication.</param>
<param name="checkCertificateRevocation">A <see cref="T:System.Boolean" /> value that specifies whether the certificate revocation list is checked during authentication.</param>
<summary>Called by clients to authenticate the server and optionally the client in a client-server connection. The authentication process uses the specified certificate collection and SSL protocol.</summary>
<remarks>
Expand Down Expand Up @@ -891,7 +891,7 @@
<Docs>
<param name="targetHost">The name of the server that will share this <see cref="T:System.Net.Security.SslStream" />.</param>
<param name="clientCertificates">The <see cref="T:System.Security.Cryptography.X509Certificates.X509CertificateCollection" /> that contains client certificates.</param>
<param name="enabledSslProtocols">The <see cref="T:System.Security.Authentication.SslProtocols" /> value that represents the protocol used for authentication.</param>
<param name="enabledSslProtocols">The <see cref="T:System.Security.Authentication.SslProtocols" /> value that represents protocols used for authentication.</param>
<param name="checkCertificateRevocation">A <see cref="T:System.Boolean" /> value that specifies whether the certificate revocation list is checked during authentication.</param>
<summary>Called by clients to authenticate the server and optionally the client in a client-server connection as an asynchronous operation. The authentication process uses the specified certificate collection and SSL protocol.</summary>
<returns>The task object representing the asynchronous operation.</returns>
Expand Down Expand Up @@ -1092,7 +1092,7 @@
<Docs>
<param name="serverCertificate">The X509Certificate used to authenticate the server.</param>
<param name="clientCertificateRequired">A <see cref="T:System.Boolean" /> value that specifies whether the client is asked for a certificate for authentication. Note that this is only a request -- if no certificate is provided, the server still accepts the connection request.</param>
<param name="enabledSslProtocols">The <see cref="T:System.Security.Authentication.SslProtocols" /> value that represents the protocol used for authentication.</param>
<param name="enabledSslProtocols">The <see cref="T:System.Security.Authentication.SslProtocols" /> value that represents protocols used for authentication.</param>
<param name="checkCertificateRevocation">A <see cref="T:System.Boolean" /> value that specifies whether the certificate revocation list is checked during authentication.</param>
<summary>Called by servers to authenticate the server and optionally the client in a client-server connection using the specified certificates, requirements and security protocol.</summary>
<remarks>
Expand Down Expand Up @@ -1324,7 +1324,7 @@
<Docs>
<param name="serverCertificate">The X509Certificate used to authenticate the server.</param>
<param name="clientCertificateRequired">A <see cref="T:System.Boolean" /> value that specifies whether the client is asked for a certificate for authentication. Note that this is only a request -- if no certificate is provided, the server still accepts the connection request.</param>
<param name="enabledSslProtocols">The <see cref="T:System.Security.Authentication.SslProtocols" /> value that represents the protocol used for authentication.</param>
<param name="enabledSslProtocols">The <see cref="T:System.Security.Authentication.SslProtocols" /> value that represents protocols used for authentication.</param>
<param name="checkCertificateRevocation">A <see cref="T:System.Boolean" /> value that specifies whether the certificate revocation list is checked during authentication.</param>
<summary>Called by servers to authenticate the server and optionally the client in a client-server connection using the specified certificates, requirements and security protocol as an asynchronous operation.</summary>
<returns>The task object representing the asynchronous operation.</returns>
Expand Down Expand Up @@ -1548,7 +1548,7 @@
<Docs>
<param name="targetHost">The name of the server that shares this <see cref="T:System.Net.Security.SslStream" />.</param>
<param name="clientCertificates">The <see cref="T:System.Security.Cryptography.X509Certificates.X509CertificateCollection" /> containing client certificates.</param>
<param name="enabledSslProtocols">The <see cref="T:System.Security.Authentication.SslProtocols" /> value that represents the protocol used for authentication.</param>
<param name="enabledSslProtocols">The <see cref="T:System.Security.Authentication.SslProtocols" /> value that represents protocols used for authentication.</param>
<param name="checkCertificateRevocation">A <see cref="T:System.Boolean" /> value that specifies whether the certificate revocation list is checked during authentication.</param>
<param name="asyncCallback">An <see cref="T:System.AsyncCallback" /> delegate that references the method to invoke when the authentication is complete.</param>
<param name="asyncState">A user-defined object that contains information about the operation. This object is passed to the <paramref name="asyncCallback" /> delegate when the operation completes.</param>
Expand Down Expand Up @@ -1800,7 +1800,7 @@
<Docs>
<param name="serverCertificate">The X509Certificate used to authenticate the server.</param>
<param name="clientCertificateRequired">A <see cref="T:System.Boolean" /> value that specifies whether the client is asked for a certificate for authentication. Note that this is only a request -- if no certificate is provided, the server still accepts the connection request.</param>
<param name="enabledSslProtocols">The <see cref="T:System.Security.Authentication.SslProtocols" /> value that represents the protocol used for authentication.</param>
<param name="enabledSslProtocols">The <see cref="T:System.Security.Authentication.SslProtocols" /> value that represents protocols used for authentication.</param>
<param name="checkCertificateRevocation">A <see cref="T:System.Boolean" /> value that specifies whether the certificate revocation list is checked during authentication.</param>
<param name="asyncCallback">An <see cref="T:System.AsyncCallback" /> delegate that references the method to invoke when the authentication is complete.</param>
<param name="asyncState">A user-defined object that contains information about the operation. This object is passed to the <paramref name="asyncCallback" /> delegate when the operation completes.</param>
Expand Down Expand Up @@ -4041,7 +4041,7 @@ This property gets the cipher suite that is going to be used in the communicatio
</ReturnValue>
<Docs>
<summary>Gets a value that indicates the security protocol used to authenticate this connection.</summary>
<value>The <see cref="T:System.Security.Authentication.SslProtocols" /> value that represents the protocol used for authentication.</value>
<value>The <see cref="T:System.Security.Authentication.SslProtocols" /> value that represents protocols used for authentication.</value>
<remarks>
<format type="text/markdown"><![CDATA[

Expand Down
4 changes: 4 additions & 0 deletions xml/System.Security.Authentication/SslProtocols.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,10 @@
<summary>Defines the possible versions of <see cref="T:System.Security.Authentication.SslProtocols" />.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
During the handshake, the client sends a list of SSL versions and the server chooses from that list the best matching version.
]]></format>
</remarks>
</Docs>
Expand Down