Skip to content

Commit 182265f

Browse files
authored
Port System.Security.Cryptography docs for .NET 9
2 parents 1497e34 + 0fd356f commit 182265f

File tree

2 files changed

+20
-8
lines changed

2 files changed

+20
-8
lines changed

xml/System.Security.Cryptography/CngKeyCreationOptions.xml

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -205,7 +205,7 @@
205205
</ReturnValue>
206206
<MemberValue>65536</MemberValue>
207207
<Docs>
208-
<summary>To be added.</summary>
208+
<summary>Indicates a key should be protected with Virtualization-based security (VBS).</summary>
209209
</Docs>
210210
</Member>
211211
<Member MemberName="RequireVbs">
@@ -231,7 +231,7 @@
231231
</ReturnValue>
232232
<MemberValue>131072</MemberValue>
233233
<Docs>
234-
<summary>To be added.</summary>
234+
<summary>Indicates a key must be protected with Virtualization-based security (VBS).</summary>
235235
</Docs>
236236
</Member>
237237
<Member MemberName="UsePerBootKey">
@@ -257,7 +257,9 @@
257257
</ReturnValue>
258258
<MemberValue>262144</MemberValue>
259259
<Docs>
260-
<summary>To be added.</summary>
260+
<summary>
261+
<para>Instructs Virtualization-based security (VBS) to protect the client key with a per-boot key when combined with <see cref="F:System.Security.Cryptography.CngKeyCreationOptions.RequireVbs" /> or <see cref="F:System.Security.Cryptography.CngKeyCreationOptions.PreferVbs" />.</para>
262+
</summary>
261263
</Docs>
262264
</Member>
263265
</Members>

xml/System.Security.Cryptography/SafeEvpPKeyHandle.xml

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -260,11 +260,21 @@
260260
<Parameter Name="keyUri" Type="System.String" Index="1" FrameworkAlternate="net-9.0" />
261261
</Parameters>
262262
<Docs>
263-
<param name="providerName">To be added.</param>
264-
<param name="keyUri">To be added.</param>
265-
<summary>To be added.</summary>
266-
<returns>To be added.</returns>
267-
<remarks>To be added.</remarks>
263+
<param name="providerName">The name of the <code>OSSL_PROVIDER</code> to process the key open request.</param>
264+
<param name="keyUri">The URI assigned by the <code>OSSL_PROVIDER</code> of the key to open.</param>
265+
<summary>Opens a named key using a named <code>OSSL_PROVIDER</code>.</summary>
266+
<returns>The opened key.</returns>
267+
<remarks>
268+
<para>Both <paramref name="providerName" /> and <paramref name="keyUri" /> must be trusted inputs.</para>
269+
<para>This operation will fail if OpenSSL cannot successfully load the named <code>OSSL_PROVIDER</code>, or if the named <code>OSSL_PROVIDER</code> cannot load the named key.</para>
270+
<para>The syntax for <paramref name="keyUri" /> is determined by each individual named <code>OSSL_PROVIDER</code>.</para>
271+
</remarks>
272+
<exception cref="T:System.ArgumentNullException">
273+
<paramref name="providerName" /> or <paramref name="keyUri" /> is <see langword="null" />.</exception>
274+
<exception cref="T:System.ArgumentException">
275+
<paramref name="providerName" /> or <paramref name="keyUri" /> is the empty string.</exception>
276+
<exception cref="T:System.PlatformNotSupportedException">The current platform does not support OpenSSL Providers.</exception>
277+
<exception cref="T:System.Security.Cryptography.CryptographicException">The key could not be opened via the specified named <code>OSSL_PROVIDER</code>.</exception>
268278
</Docs>
269279
</Member>
270280
<Member MemberName="OpenPrivateKeyFromEngine">

0 commit comments

Comments
 (0)