From 6f3c7eed3e9dcde95028d6f2d08171b73d18801e Mon Sep 17 00:00:00 2001 From: Kevin Jones Date: Wed, 4 Sep 2024 11:14:40 -0400 Subject: [PATCH 1/3] Add missing System.Security.Cryptography documentation for .NET 9 --- .../CngKeyCreationOptions.xml | 8 +++++--- .../SafeEvpPKeyHandle.xml | 15 ++++++++++----- 2 files changed, 15 insertions(+), 8 deletions(-) diff --git a/xml/System.Security.Cryptography/CngKeyCreationOptions.xml b/xml/System.Security.Cryptography/CngKeyCreationOptions.xml index 3185843a385..8d3582ea546 100644 --- a/xml/System.Security.Cryptography/CngKeyCreationOptions.xml +++ b/xml/System.Security.Cryptography/CngKeyCreationOptions.xml @@ -205,7 +205,7 @@ 65536 - To be added. + Indicates a key should be protected with Virtualization-based security (VBS). @@ -231,7 +231,7 @@ 131072 - To be added. + Indicates a key must be protected with Virtualization-based security (VBS). @@ -257,7 +257,9 @@ 262144 - To be added. + + Instructs Virtualization-based security (VBS) to protect the client key with a per-boot key when combined with or . + diff --git a/xml/System.Security.Cryptography/SafeEvpPKeyHandle.xml b/xml/System.Security.Cryptography/SafeEvpPKeyHandle.xml index 9efd21776ce..19e3030b27f 100644 --- a/xml/System.Security.Cryptography/SafeEvpPKeyHandle.xml +++ b/xml/System.Security.Cryptography/SafeEvpPKeyHandle.xml @@ -260,11 +260,16 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The name of the OSSL_PROVIDER to process the key open request. + The URI assigned by the OSSL_PROVIDER of the key to open. + Open a named public key using a named OSSL_PROVIDER. + The opened key. + <para><para> Both <paramref name="providerName" /> and <paramref name="keyUri" /> must be trusted inputs.</para><para></para><para> This operation will fail if OpenSSL cannot successfully load the named <c>OSSL_PROVIDER</c>, or if the named <c>OSSL_PROVIDER</c> cannot load the named key.</para><para></para><para> The syntax for <paramref name="keyUri" /> is determined by each individual named <c>OSSL_PROVIDER</c>.</para><para></para> + + or is . + + or is the empty string. + the key could not be opened via the specified named OSSL_PROVIDER. From 7e2b999f91cc10058a9c72e4d1b8ef50f52ba185 Mon Sep 17 00:00:00 2001 From: Kevin Jones Date: Wed, 4 Sep 2024 11:28:48 -0400 Subject: [PATCH 2/3] Manual fixes --- .../SafeEvpPKeyHandle.xml | 15 ++++++++++----- 1 file changed, 10 insertions(+), 5 deletions(-) diff --git a/xml/System.Security.Cryptography/SafeEvpPKeyHandle.xml b/xml/System.Security.Cryptography/SafeEvpPKeyHandle.xml index 19e3030b27f..1a0943d3c26 100644 --- a/xml/System.Security.Cryptography/SafeEvpPKeyHandle.xml +++ b/xml/System.Security.Cryptography/SafeEvpPKeyHandle.xml @@ -260,16 +260,21 @@ - The name of the OSSL_PROVIDER to process the key open request. - The URI assigned by the OSSL_PROVIDER of the key to open. - Open a named public key using a named OSSL_PROVIDER. + The name of the OSSL_PROVIDER to process the key open request. + The URI assigned by the OSSL_PROVIDER of the key to open. + Open a named key using a named OSSL_PROVIDER. The opened key. - <para><para> Both <paramref name="providerName" /> and <paramref name="keyUri" /> must be trusted inputs.</para><para></para><para> This operation will fail if OpenSSL cannot successfully load the named <c>OSSL_PROVIDER</c>, or if the named <c>OSSL_PROVIDER</c> cannot load the named key.</para><para></para><para> The syntax for <paramref name="keyUri" /> is determined by each individual named <c>OSSL_PROVIDER</c>.</para><para></para> + + Both and must be trusted inputs. + This operation will fail if OpenSSL cannot successfully load the named OSSL_PROVIDER, or if the named OSSL_PROVIDER cannot load the named key. + The syntax for is determined by each individual named OSSL_PROVIDER. + or is . or is the empty string. - the key could not be opened via the specified named OSSL_PROVIDER. + The current platform does not support OpenSSL Providers. + The key could not be opened via the specified named OSSL_PROVIDER. From 0fd356fc0058ebd277d4d961c09648141a64ca52 Mon Sep 17 00:00:00 2001 From: Kevin Jones Date: Wed, 4 Sep 2024 13:07:46 -0400 Subject: [PATCH 3/3] Update xml/System.Security.Cryptography/SafeEvpPKeyHandle.xml Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com> --- xml/System.Security.Cryptography/SafeEvpPKeyHandle.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/xml/System.Security.Cryptography/SafeEvpPKeyHandle.xml b/xml/System.Security.Cryptography/SafeEvpPKeyHandle.xml index 1a0943d3c26..56ae15abd0f 100644 --- a/xml/System.Security.Cryptography/SafeEvpPKeyHandle.xml +++ b/xml/System.Security.Cryptography/SafeEvpPKeyHandle.xml @@ -262,7 +262,7 @@ The name of the OSSL_PROVIDER to process the key open request. The URI assigned by the OSSL_PROVIDER of the key to open. - Open a named key using a named OSSL_PROVIDER. + Opens a named key using a named OSSL_PROVIDER. The opened key. Both and must be trusted inputs.