From cf1d83400e3a11e8672bd6ec7197b6820967ddf6 Mon Sep 17 00:00:00 2001 From: Jan Jahoda Date: Thu, 11 Jun 2020 11:22:10 +0200 Subject: [PATCH 01/14] NegotiateStream - update documentation --- .../SslClientAuthenticationOptions.xml | 63 +++++++++++++------ 1 file changed, 44 insertions(+), 19 deletions(-) diff --git a/xml/System.Net.Security/SslClientAuthenticationOptions.xml b/xml/System.Net.Security/SslClientAuthenticationOptions.xml index 36260fafe0b..d3fd54f98dc 100644 --- a/xml/System.Net.Security/SslClientAuthenticationOptions.xml +++ b/xml/System.Net.Security/SslClientAuthenticationOptions.xml @@ -23,8 +23,17 @@ - To be added. - To be added. + This struct represents client authentication property bag for . + + , or . + + The uses this property bag in property. + + ]]> + @@ -46,7 +55,7 @@ - To be added. + Initializes a new instance of the class. To be added. @@ -72,8 +81,8 @@ System.Boolean - To be added. - To be added. + Gets or sets a value that indicates whether the should allow SSL renegotiation. + to indicate that the allow SSL renegotiation; otherwise, . The default value is . To be added. @@ -99,7 +108,7 @@ System.Collections.Generic.List<System.Net.Security.SslApplicationProtocol> - To be added. + Gets or sets a list of . To be added. To be added. @@ -125,10 +134,21 @@ System.Security.Cryptography.X509Certificates.X509RevocationMode - - To be added. - To be added. - To be added. + A value that specifies whether the certificate revocation list is checked during authentication. + Gets or sets the certificate revocation mode for certificate validation. + One of the values in : , , or . The default is . + + . + + For more information, see [Working with Certificates](/dotnet/framework/wcf/feature-details/working-with-certificates). + + ]]> + + + The value contains an invalid enumeration value. @@ -179,9 +199,14 @@ System.Security.Cryptography.X509Certificates.X509CertificateCollection - To be added. + List of the client certificates offered to the server. To be added. - To be added. + can be used to select specify certificate which is offered to the server. + + ]]> @@ -206,8 +231,8 @@ System.Security.Authentication.SslProtocols - To be added. - To be added. + Gets or sets the value that represents the protocol used for authentication. + The default value is To be added. @@ -233,8 +258,8 @@ System.Net.Security.EncryptionPolicy - To be added. - To be added. + Gets or sets the . + The default value is To be added. @@ -260,7 +285,7 @@ System.Net.Security.LocalCertificateSelectionCallback - To be added. + Gets or sets a delegate responsible for selecting the certificate used for authentication. To be added. To be added. @@ -287,7 +312,7 @@ System.Net.Security.RemoteCertificateValidationCallback - To be added. + Gets or sets a delegate responsible for validating the certificate supplied by the remote party. To be added. To be added. @@ -314,7 +339,7 @@ System.String - To be added. + Gets or sets the name of the server. To be added. To be added. From 0ffda34cc2dffca9c7036a4e8450a0df3b1346d1 Mon Sep 17 00:00:00 2001 From: Jan Jahoda Date: Thu, 11 Jun 2020 15:54:38 +0200 Subject: [PATCH 02/14] Fix revocation mode --- xml/System.Net.Security/SslClientAuthenticationOptions.xml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/xml/System.Net.Security/SslClientAuthenticationOptions.xml b/xml/System.Net.Security/SslClientAuthenticationOptions.xml index d3fd54f98dc..b796a904506 100644 --- a/xml/System.Net.Security/SslClientAuthenticationOptions.xml +++ b/xml/System.Net.Security/SslClientAuthenticationOptions.xml @@ -23,7 +23,7 @@ - This struct represents client authentication property bag for . + This struct represents a client authentication property bag for the . System.Security.Cryptography.X509Certificates.X509RevocationMode - A value that specifies whether the certificate revocation list is checked during authentication. + Gets or sets the certificate revocation mode for certificate validation. One of the values in : , , or . The default is . From 99581cb1391061a6585bbe5b834be3f2156bea60 Mon Sep 17 00:00:00 2001 From: Jan Jahoda Date: Thu, 11 Jun 2020 17:18:24 +0200 Subject: [PATCH 03/14] Fix see reference --- xml/System.Net.Security/SslClientAuthenticationOptions.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/xml/System.Net.Security/SslClientAuthenticationOptions.xml b/xml/System.Net.Security/SslClientAuthenticationOptions.xml index b796a904506..9fa151f483f 100644 --- a/xml/System.Net.Security/SslClientAuthenticationOptions.xml +++ b/xml/System.Net.Security/SslClientAuthenticationOptions.xml @@ -81,7 +81,7 @@ System.Boolean - Gets or sets a value that indicates whether the should allow SSL renegotiation. + Gets or sets a value that indicates whether the should allow SSL renegotiation. to indicate that the allow SSL renegotiation; otherwise, . The default value is . To be added. From 25eb59e82bd9fc21e38f5b842ab15999101b9db4 Mon Sep 17 00:00:00 2001 From: Jan Jahoda Date: Mon, 15 Jun 2020 13:28:28 +0200 Subject: [PATCH 04/14] minor changes --- xml/System.Net.Security/SslClientAuthenticationOptions.xml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/xml/System.Net.Security/SslClientAuthenticationOptions.xml b/xml/System.Net.Security/SslClientAuthenticationOptions.xml index 9fa151f483f..bf586d2c95b 100644 --- a/xml/System.Net.Security/SslClientAuthenticationOptions.xml +++ b/xml/System.Net.Security/SslClientAuthenticationOptions.xml @@ -28,7 +28,7 @@ , or . + This property bag is used as argument for . The uses this property bag in property. @@ -231,7 +231,7 @@ System.Security.Authentication.SslProtocols - Gets or sets the value that represents the protocol used for authentication. + Gets or sets the value that represents protocols used for authentication. The default value is To be added. From 5cc0dcfcab1f3e316f6198a6daa902ffd745a7c7 Mon Sep 17 00:00:00 2001 From: Jan Jahoda Date: Tue, 16 Jun 2020 12:59:13 +0200 Subject: [PATCH 05/14] Fix reference in class description --- xml/System.Net.Security/SslClientAuthenticationOptions.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/xml/System.Net.Security/SslClientAuthenticationOptions.xml b/xml/System.Net.Security/SslClientAuthenticationOptions.xml index bf586d2c95b..91edf8fc492 100644 --- a/xml/System.Net.Security/SslClientAuthenticationOptions.xml +++ b/xml/System.Net.Security/SslClientAuthenticationOptions.xml @@ -30,7 +30,7 @@ ## Remarks This property bag is used as argument for . - The uses this property bag in property. + The uses this property bag in property. ]]> From c35002c5da36f5687f9ca5b456980fa37761dfc6 Mon Sep 17 00:00:00 2001 From: Jan Jahoda Date: Wed, 17 Jun 2020 11:33:51 +0200 Subject: [PATCH 06/14] Apply PR comments --- xml/System.Net.Security/SslClientAuthenticationOptions.xml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/xml/System.Net.Security/SslClientAuthenticationOptions.xml b/xml/System.Net.Security/SslClientAuthenticationOptions.xml index 91edf8fc492..881903187a3 100644 --- a/xml/System.Net.Security/SslClientAuthenticationOptions.xml +++ b/xml/System.Net.Security/SslClientAuthenticationOptions.xml @@ -109,7 +109,7 @@ Gets or sets a list of . - To be added. + The default value is , which is the recommended value. See for more details. To be added. @@ -285,7 +285,7 @@ System.Net.Security.LocalCertificateSelectionCallback - Gets or sets a delegate responsible for selecting the certificate used for authentication. + Gets or sets a delegate responsible for selecting the client authentication certificate used for authentication. To be added. To be added. @@ -339,7 +339,7 @@ System.String - Gets or sets the name of the server. + 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 IP address. To be added. To be added. From b36de792b78ca74760e7de90ba836daf50ed256b Mon Sep 17 00:00:00 2001 From: Jan Jahoda Date: Wed, 17 Jun 2020 12:01:37 +0200 Subject: [PATCH 07/14] fix closing tag --- xml/System.Net.Security/SslClientAuthenticationOptions.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/xml/System.Net.Security/SslClientAuthenticationOptions.xml b/xml/System.Net.Security/SslClientAuthenticationOptions.xml index 881903187a3..311b9b07752 100644 --- a/xml/System.Net.Security/SslClientAuthenticationOptions.xml +++ b/xml/System.Net.Security/SslClientAuthenticationOptions.xml @@ -109,7 +109,7 @@ Gets or sets a list of . - The default value is , which is the recommended value. See for more details. + The default value is , which is the recommended value. See for more details. To be added. From 2c69b7bb4aa79f8e0a13746bbf554c31afba5a1b Mon Sep 17 00:00:00 2001 From: Jan Jahoda Date: Wed, 17 Jun 2020 12:17:31 +0200 Subject: [PATCH 08/14] apply review comments --- xml/System.Net.Security/SslClientAuthenticationOptions.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/xml/System.Net.Security/SslClientAuthenticationOptions.xml b/xml/System.Net.Security/SslClientAuthenticationOptions.xml index 311b9b07752..54573649aad 100644 --- a/xml/System.Net.Security/SslClientAuthenticationOptions.xml +++ b/xml/System.Net.Security/SslClientAuthenticationOptions.xml @@ -108,7 +108,7 @@ System.Collections.Generic.List<System.Net.Security.SslApplicationProtocol> - Gets or sets a list of . + Gets or sets a list of ALPN protocols. The default value is , which is the recommended value. See for more details. To be added. From 3ef98fd5501d1c57cd1855e3acf49932de81053d Mon Sep 17 00:00:00 2001 From: Jan Jahoda Date: Thu, 18 Jun 2020 10:37:20 +0200 Subject: [PATCH 09/14] Update xml/System.Net.Security/SslClientAuthenticationOptions.xml Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com> --- xml/System.Net.Security/SslClientAuthenticationOptions.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/xml/System.Net.Security/SslClientAuthenticationOptions.xml b/xml/System.Net.Security/SslClientAuthenticationOptions.xml index 54573649aad..9e9d44b0f62 100644 --- a/xml/System.Net.Security/SslClientAuthenticationOptions.xml +++ b/xml/System.Net.Security/SslClientAuthenticationOptions.xml @@ -28,7 +28,7 @@ . + This property bag is used as argument for and, in .NET 5.0 and later versions, for . The uses this property bag in property. From b11bee9b81cd4493be960be800a5c395e8e3bee9 Mon Sep 17 00:00:00 2001 From: Jan Jahoda Date: Thu, 18 Jun 2020 10:38:09 +0200 Subject: [PATCH 10/14] Remove wrong ApplicationProtocols description --- xml/System.Net.Security/SslClientAuthenticationOptions.xml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/xml/System.Net.Security/SslClientAuthenticationOptions.xml b/xml/System.Net.Security/SslClientAuthenticationOptions.xml index 54573649aad..3fb157b5abb 100644 --- a/xml/System.Net.Security/SslClientAuthenticationOptions.xml +++ b/xml/System.Net.Security/SslClientAuthenticationOptions.xml @@ -109,7 +109,7 @@ Gets or sets a list of ALPN protocols. - The default value is , which is the recommended value. See for more details. + To be added. To be added. @@ -232,7 +232,7 @@ Gets or sets the value that represents protocols used for authentication. - The default value is + The default value is , which is the recommended value. See for more details. To be added. From 73302ac0ea977d18ca4db7771844b78b088b9409 Mon Sep 17 00:00:00 2001 From: Jan Jahoda Date: Fri, 26 Jun 2020 14:20:07 +0200 Subject: [PATCH 11/14] RP comments --- xml/System.Net.Security/SslClientAuthenticationOptions.xml | 5 +++-- xml/System.Net.Security/SslServerAuthenticationOptions.xml | 2 +- 2 files changed, 4 insertions(+), 3 deletions(-) diff --git a/xml/System.Net.Security/SslClientAuthenticationOptions.xml b/xml/System.Net.Security/SslClientAuthenticationOptions.xml index 0fc20093335..66596033691 100644 --- a/xml/System.Net.Security/SslClientAuthenticationOptions.xml +++ b/xml/System.Net.Security/SslClientAuthenticationOptions.xml @@ -199,11 +199,12 @@ System.Security.Cryptography.X509Certificates.X509CertificateCollection - List of the client certificates offered to the server. + Collection of certificates to be considered for client's authentication to server. To be added. can be used to select specify certificate which is offered to the server. ]]> @@ -231,7 +232,7 @@ System.Security.Authentication.SslProtocols - Gets or sets the value that represents protocols used for authentication. + Gets or sets the value that represents protocol versions offered by client to the server during authentication. The default value is , which is the recommended value. See for more details. To be added. diff --git a/xml/System.Net.Security/SslServerAuthenticationOptions.xml b/xml/System.Net.Security/SslServerAuthenticationOptions.xml index 0d284142827..fe79d6b6cc0 100644 --- a/xml/System.Net.Security/SslServerAuthenticationOptions.xml +++ b/xml/System.Net.Security/SslServerAuthenticationOptions.xml @@ -225,7 +225,7 @@ System.Security.Authentication.SslProtocols - Gets or sets the value that represents protocols used for authentication. + Gets or sets the value that represents protocol versions offered by client to the server during authentication. The default value is , which is the recommended value. See for more details. To be added. From bfb27e25b56de682c436ce443e84de6a95d17895 Mon Sep 17 00:00:00 2001 From: Jan Jahoda Date: Fri, 26 Jun 2020 14:24:10 +0200 Subject: [PATCH 12/14] RP comments --- xml/System.Net.Security/SslServerAuthenticationOptions.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/xml/System.Net.Security/SslServerAuthenticationOptions.xml b/xml/System.Net.Security/SslServerAuthenticationOptions.xml index fe79d6b6cc0..c80216b1158 100644 --- a/xml/System.Net.Security/SslServerAuthenticationOptions.xml +++ b/xml/System.Net.Security/SslServerAuthenticationOptions.xml @@ -225,7 +225,7 @@ System.Security.Authentication.SslProtocols - Gets or sets the value that represents protocol versions offered by client to the server during authentication. + Gets or sets the value that represents protocol versions used by server to match the client protocol version during authentication. The default value is , which is the recommended value. See for more details. To be added. From 32765db18d3d8dc0d12f903fd9042cec3d53004c Mon Sep 17 00:00:00 2001 From: Jan Jahoda Date: Tue, 7 Jul 2020 11:02:39 +0200 Subject: [PATCH 13/14] Apply suggestions from code review Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com> --- .../SslClientAuthenticationOptions.xml | 26 +++++++++---------- .../SslServerAuthenticationOptions.xml | 2 +- 2 files changed, 14 insertions(+), 14 deletions(-) diff --git a/xml/System.Net.Security/SslClientAuthenticationOptions.xml b/xml/System.Net.Security/SslClientAuthenticationOptions.xml index 66596033691..47fc0b0e970 100644 --- a/xml/System.Net.Security/SslClientAuthenticationOptions.xml +++ b/xml/System.Net.Security/SslClientAuthenticationOptions.xml @@ -23,14 +23,14 @@ - This struct represents a client authentication property bag for the . + Represents a client authentication property bag for the . and, in .NET 5.0 and later versions, for . - The uses this property bag in property. + The uses this property bag in the property. ]]> @@ -82,7 +82,7 @@ Gets or sets a value that indicates whether the should allow SSL renegotiation. - to indicate that the allow SSL renegotiation; otherwise, . The default value is . + to indicate that the allows SSL renegotiation; otherwise, . The default value is . To be added. @@ -141,7 +141,7 @@ . + 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 . For more information, see [Working with Certificates](/dotnet/framework/wcf/feature-details/working-with-certificates). @@ -199,13 +199,13 @@ System.Security.Cryptography.X509Certificates.X509CertificateCollection - Collection of certificates to be considered for client's authentication to server. + A collection of certificates to be considered for the client's authentication to the server. To be added. can be used to select specify certificate which is offered to the server. + can be used to select a specific certificate to offer to the server. ]]> @@ -232,8 +232,8 @@ System.Security.Authentication.SslProtocols - Gets or sets the value that represents protocol versions offered by client to the server during authentication. - The default value is , which is the recommended value. See for more details. + Gets or sets the value that represents the protocol versions offered by the client to the server during authentication. + The default value is , which is the recommended value. For more information, see . To be added. @@ -259,8 +259,8 @@ System.Net.Security.EncryptionPolicy - Gets or sets the . - The default value is + Gets or sets the encryption policy. + The default value is . To be added. @@ -286,7 +286,7 @@ System.Net.Security.LocalCertificateSelectionCallback - Gets or sets a delegate responsible for selecting the client authentication certificate used for authentication. + Gets or sets a delegate that's responsible for selecting the client authentication certificate used for authentication. To be added. To be added. @@ -313,7 +313,7 @@ System.Net.Security.RemoteCertificateValidationCallback - Gets or sets a delegate responsible for validating the certificate supplied by the remote party. + Gets or sets a delegate that's responsible for validating the certificate supplied by the remote party. To be added. To be added. @@ -340,7 +340,7 @@ System.String - 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 IP address. + 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. To be added. To be added. diff --git a/xml/System.Net.Security/SslServerAuthenticationOptions.xml b/xml/System.Net.Security/SslServerAuthenticationOptions.xml index c80216b1158..2076be7aa59 100644 --- a/xml/System.Net.Security/SslServerAuthenticationOptions.xml +++ b/xml/System.Net.Security/SslServerAuthenticationOptions.xml @@ -225,7 +225,7 @@ System.Security.Authentication.SslProtocols - Gets or sets the value that represents protocol versions used by server to match the client protocol version during authentication. + Gets or sets a value that represents protocol versions used by the server to match the client protocol version during authentication. The default value is , which is the recommended value. See for more details. To be added. From 00b4c0667acde03cb0f408970d80f071b06eab8a Mon Sep 17 00:00:00 2001 From: Jan Jahoda Date: Tue, 7 Jul 2020 11:39:40 +0200 Subject: [PATCH 14/14] Fix remark is not visible --- xml/System.Net.Security/SslClientAuthenticationOptions.xml | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/xml/System.Net.Security/SslClientAuthenticationOptions.xml b/xml/System.Net.Security/SslClientAuthenticationOptions.xml index 47fc0b0e970..dded32c7989 100644 --- a/xml/System.Net.Security/SslClientAuthenticationOptions.xml +++ b/xml/System.Net.Security/SslClientAuthenticationOptions.xml @@ -137,7 +137,7 @@ Gets or sets the certificate revocation mode for certificate validation. One of the values in : , , or . The default is . - + A collection of certificates to be considered for the client's authentication to the server. To be added. - + can be used to select a specific certificate to offer to the server. ]]> +