8000 Add ssl API added between preview 7 and 8 · dotnet/dotnet-api-docs@35e8a29 · GitHub
[go: up one dir, main page]
Skip to content

Commit 35e8a29

Browse files
author
Jan Jahoda
committed
Add ssl API added between preview 7 and 8
1 parent 5905bb6 commit 35e8a29

File tree

6 files changed

+55
-27
lines changed

6 files changed

+55
-27
lines changed

‎xml/System.Net.Http/WinHttpHandler.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -416,8 +416,8 @@ When this property is set to `true`, all HTTP redirect responses from the server
416416
<ReturnType>System.Boolean</ReturnType>
417417
</ReturnValue>
418418
<Docs>
419-
<summary>To be added.</summary>
420-
<value>To be added.</value>
419+
<summary>Gets or sets a value that indicates whether additional HTTP/2 connections can be established to the same server when the maximum of concurrent streams is reached on all existing connections.</summary>
420+
<value>If <see langword="true" />, additional HTTP/2 connection can be created. Otherwise, if <see langword="false" />, no additional HTTP/2 connection can be created.</value>
421421
<remarks>To be added.</remarks>
422422
</Docs>
423423
</Member>

‎xml/System.Net.Security/ServerOptionsSelectionCallback.xml

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -22,12 +22,18 @@
2222
<ReturnType>System.Threading.Tasks.ValueTask&lt;System.Net.Security.SslServerAuthenticationOptions&gt;</ReturnType>
2323
</ReturnValue>
2424
<Docs>
25-
<param name="stream">To be added.</param>
26-
<param name="clientHelloInfo">To be added.</param>
27-
<param name="state">To be added.</param>
28-
<param name="cancellationToken">To be added.</param>
29-
<summary>To be added.</summary>
30-
<returns>To be added.</returns>
31-
<remarks>To be added.</remarks>
25+
<param name="stream">The TLS stream on which the authentication happens.</param>
26+
<param name="clientHelloInfo">Represents an information from the Client Hello message.</param>
27+
<param name="state">The information that was passed when registering the callback.</param>
28+
<param name="cancellationToken">The token to monitor for cancellation requests.</param>
29+
<summary>The asynchronous callback to select session properties based on name requested by client.</summary>
30+
<returns>A server authentication property bag.</returns>
31+
<remarks>
32+
<format type="text/markdown"><![CDATA[
33+
34+
This delegate provides authentication properties during the server authenticaton as an asynchronous operation.
35+
36+
]]></format>
37+
</remarks>
3238
</Docs>
3339
</Type>

‎xml/System.Net.Security/SslClientHelloInfo.xml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@
4040
<ReturnType>System.String</ReturnType>
4141
</ReturnValue>
4242
<Docs>
43-
<summary>To be added.</summary>
43+
<summary>The host server specified by the client.</summary>
4444
<value>To be added.</value>
4545
<remarks>To be added.</remarks>
4646
</Docs>
@@ -61,8 +61,8 @@
6161
<ReturnType>System.Security.Authentication.SslProtocols</ReturnType>
6262
</ReturnValue>
6363
<Docs>
64-
<summary>To be added.</summary>
65-
<value>To be added.</value>
64+
<summary>Gets or sets the TLS/SSL protocols offered by client.</summary>
65+
<value>One of the values defined in the <see cref="T:System.Security.Authentication.SslProtocols" /> enumeration.</value>
6666
<remarks>To be added.</remarks>
6767
</Docs>
6868
</Member>

‎xml/System.Net.Security/SslServerAuthenticationOptions.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -332,7 +332,7 @@
332332
<ReturnType>System.Net.Security.SslStreamCertificateContext</ReturnType>
333333
</ReturnValue>
334334
<Docs>
335-
<summary>To be added.</summary>
335+
<summary>Gets or sets the server certificate context.</summary>
336336
<value>To be added.</value>
337337
<remarks>To be added.</remarks>
338338
</Docs>

‎xml/System.Net.Security/SslStream.xml

Lines changed: 29 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1399,7 +1399,7 @@
13991399
]]></format>
14001400
</remarks>
14011401
<exception cref="T:System.ArgumentNullException">
1402-
Either <see cref="P:System.Net.Security.SslServerAuthenticationOptions.ServerCertificateSelectionCallback" /> or <see cref="P:System.Net.Security.SslServerAuthenticationOptions.ServerCertificate" /> is <see langword="null" /> and <see cref="T:System.Net.Security.LocalCertificateSelectionCallback" /> is not set in the <see langword="SslStream" /> constructor.</exception>
1402+
Either <see cref="P:System.Net.Security.SslServerAuthenticationOptions.ServerCertificateSelectionCallback" /> or <see cref="P:System.Net.Security.SslServerAuthenticationOptions.ServerCertificate" /> or <see cref="P:System.Net.Security.SslServerAuthenticationOptions.ServerCertificateContext" > is <see langword="null" /> and <see cref="T:System.Net.Security.LocalCertificateSelectionCallback" /> is not set in the <see langword="SslStream" /> constructor.</exception>
14031403
<exception cref="T:System.ArgumentNullException">
14041404
<paramref name="sslServerAuthenticationOptions" /> is <see langword="null" />.</exception>
14051405
<exception cref="T:System.Security.Authentication.AuthenticationException">The authentication failed and left this object in an unusable state.</exception>
@@ -1438,12 +1438,33 @@
14381438
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" Index="2" FrameworkAlternate="net-5.0" />
14391439
</Parameters>
14401440
<Docs>
1441-
<param name="optionsCallback">To be added.</param>
1442-
<param name="state">To be added.</param>
1443-
<param name="cancellationToken">To be added.</param>
1444-
<summary>To be added.</summary>
1445-
<returns>To be added.</returns>
1446-
<remarks>To be added.</remarks>
1441+
<param name="optionsCallback">Gets or sets the ServerOptionsSelectionCallback callback.</param>
1442+
<param name="state">The state object passed as state parameter of <see cref="T:System.Net.Security.ServerOptionsSelectionCallback" /> when the callback provided in <paramref name="optionsCallback" /> is invoked.</param>
1443+
<param name="cancellationToken">The token to monitor for cancellation requests.</param>
1444+
<summary>Called by servers to authenticate the server and optionally the client in a client-server connection as an asynchronous operation. The authentication process uses information returned by the <paramref name="optionsCallback" />.</summary>
1445+
<returns>The task object representing the asynchronous operation.</returns>
1446+
<remarks>
1447+
<format type="text/markdown"><![CDATA[
1448+
1449+
## Remarks
1450+
1451+
If the authentication fails, you receive a <xref:System.Security.Authentication.AuthenticationException>, and this <xref:System.Net.Security.SslStream> is no longer useable. You should close this object and remove all references to it so that it can be collected by the garbage collector.
1452+
1453+
]]></format>
1454+
</remarks>
1455+
<exception cref="T:System.ArgumentNullException">
1456+
Either <see cref="P:System.Net.Security.SslServerAuthenticationOptions.ServerCertificateSelectionCallback" /> or <see cref="P:System.Net.Security.SslServerAuthenticationOptions.ServerCertificate" /> or <see cref="P:System.Net.Security.SslServerAuthenticationOptions.ServerCertificateContext" > is <see langword="null" /> and <see cref="T:System.Net.Security.LocalCertificateSelectionCallback" /> is not set in the <see langword="SslStream" /> constructor.</exception>
1457+
<exception cref="T:System.Security.Authentication.AuthenticationException">The authentication failed and left this object in an unusable state.</exception>
1458+
<exception cref="T:System.InvalidOperationException">Authentication has already occurred.
1459+
1460+
-or-
1461+
1462+
Client authentication using this <see cref="T:System.Net.Security.SslStream" /> was tried previously.
1463+
1464+
-or-
1465+
1466+
Authentication is already in progress.</exception>
1467+
<exception cref="T:System.ObjectDisposedException">This object has been closed.</exception>
14471468
</Docs>
14481469
</Member>
14491470
<Member MemberName="AuthenticateAsServerAsync">
@@ -4346,7 +4367,7 @@ This property gets the cipher suite that is going to be used in the communicatio
43464367
<ReturnType>System.String</ReturnType>
43474368
</ReturnValue>
43484369
<Docs>
4349-
<summary>To be added.</summary>
4370+
<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>
43504371
<value>To be added.</value>
43514372
<remarks>To be added.</remarks>
43524373
</Docs>

‎xml/System.Net.Security/SslStreamCertificateContext.xml

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
</Base>
1515
<Interfaces />
1616
<Docs>
17-
<summary>To be added.</summary>
17+
<summary>Represents a set of certificates used for building a certificate chain.</summary>
1818
<remarks>To be added.</remarks>
1919
</Docs>
2020
<Members>
@@ -38,12 +38,13 @@
3838
<Parameter Name="offline" Type="System.Boolean" />
3939
</Parameters>
4040
<Docs>
41-
<param name="target">To be added.</param>
42-
<param name="additionalCertificates">To be added.</param>
43-
<param name="offline">To be added.</param>
44-
<summary>To be added.</summary>
45-
<returns>To be added.</returns>
41+
<param name="target">Server certificate.</param>
42+
<param name="additionalCertificates">Certificates used for build chain.</param>
43+
<param name="offline">Specify whether the missing certificates can be downloaded.</param>
44+
<summary>Try to build the certificate chain from provided certificates.</summary>
45+
<returns>The SslStreamCertificateContext witch certificate chain created.</returns>
4646
<remarks>To be added.</remarks>
47+
<exception cref="T:System.NotSupportedException">The <paramref name="target" /> don't have associated private key.</exception>
4748
</Docs>
4849
</Member>
4950
</Members>

0 commit comments

Comments
 (0)
0