You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Adding documentation for new CipherSuitesPolicy, SslStream.NegotiatedCipherSuite and TlsCipherSuites (#2822)
* Adding documentation for new CipherSuitesPolicy, SslStream.NegotiatedCipherSuite and TlsCipherSuite.
* Apply suggestions from code review
* Adding some changes of my own as well.
Co-Authored-By: Maira Wenzel <[email protected]>
Co-Authored-By: Jeremy Barton <[email protected]>
* Apply suggestions from code review
Co-Authored-By: Ron Petrusha <[email protected]>
<paramname="allowedCipherSuites">To be added.</param>
43
-
<summary>To be added.</summary>
44
-
<remarks>To be added.</remarks>
42
+
<paramname="allowedCipherSuites">The collection of cipher suites allowed in this policy for negotiation.</param>
43
+
<summary>Initializes a new instance of the <seecref="T:System.Net.Security.CipherSuitesPolicy" /> class that can be used for client or server authentication.</summary>
44
+
<remarks>
45
+
<formattype="text/markdown"><![CDATA[
46
+
> [!NOTE]
47
+
> Defining a cipher suite policy on <xref:System.Net.Security.SslStream> authentication will prevent the OS from deciding which are the best cipher suites to negotiate with and requires that you manually check and update this code. We strongly recommend that you avoid using this feature and rely on your constantly updated OS policy.
48
+
49
+
## Remarks
50
+
51
+
Unlike the operating system's underlying SSL/TLS implementation, the order of the <xref:System.Net.Security.TlsCipherSuite> elements in `allowedCipherSuites` doesn't guarantee their priority in client-server negotiation. You can only initialize an instance of this class if you're using Linux systems with OpenSSL 1.1.1 or higher or macOS.
52
+
53
+
54
+
]]></format>
55
+
</remarks>
56
+
<exceptioncref="T:System.PlatformNotSupportedException">Platform is not a Linux system with OpenSSL 1.1.1 or higher or a macOS.</exception>
<summary>Gets a subset of valid cipher suites passed into <seecref="M:System.Net.Security.CipherSuitesPolicy.#ctor(System.Collections.Generic.IEnumerable{System.Net.Security.TlsCipherSuite})" /> constructor as a collection of cipher suites allowed in this policy for negotiation.</summary>
81
+
<value>The collection of cipher suites allowed in this policy for negotiation.</value>
82
+
<remarks>
83
+
<formattype="text/markdown"><![CDATA[
84
+
85
+
86
+
> [!NOTE]
87
+
> Defining a cipher suite policy on <xref:System.Net.Security.SslStream> authentication will prevent the OS from deciding which are the best cipher suites to negotiate with and requires that you manually check and update this code. We strongly recommend that you avoid using this feature and rely on your constantly updated OS policy.
88
+
89
+
## Remarks
90
+
Unlike the operating system's underlying SSL/TLS implementation, the order of the <xref:System.Net.Security.TlsCipherSuite> elements in `allowedCipherSuites` doesn't guarantee their priority in client-server negotiation. You can only initialize an instance of this class if you're using Linux systems with OpenSSL 1.1.1 or higher or macOS.
<summary>Gets the cipher suite which was negotiated for this connection.</summary>
3456
+
<value>One of the enumeration values that identifies the cipher suite which was negotiated for this connection.</value>
3457
+
<remarks>
3458
+
<formattype="text/markdown"><![CDATA[
3459
+
3460
+
## Remarks
3461
+
3462
+
This property gets the cipher suite that is going to be used in the communication between a client and server by the underlying SSL/TLS implementation. It is only available after a successful call to <xref:System.Net.Security.SslStream.AuthenticateAsServer%2A> or <xref:System.Net.Security.SslStream.AuthenticateAsClient%2A>.
3463
+
3464
+
]]></format>
3465
+
</remarks>
3466
+
<exceptioncref="T:System.InvalidOperationException">The property was accessed before the completion of the authentication process or the authentication process failed.</exception>
0 commit comments