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
Copy file name to clipboardExpand all lines: xml/System.Security.Cryptography/CngKeyCreationOptions.xml
+5-3Lines changed: 5 additions & 3 deletions
Original file line number
Diff line number
Diff line change
@@ -205,7 +205,7 @@
205
205
</ReturnValue>
206
206
<MemberValue>65536</MemberValue>
207
207
<Docs>
208
-
<summary>To be added.</summary>
208
+
<summary>Indicates a key should be protected with Virtualization-based security (VBS).</summary>
209
209
</Docs>
210
210
</Member>
211
211
<MemberMemberName="RequireVbs">
@@ -231,7 +231,7 @@
231
231
</ReturnValue>
232
232
<MemberValue>131072</MemberValue>
233
233
<Docs>
234
-
<summary>To be added.</summary>
234
+
<summary>Indicates a key must be protected with Virtualization-based security (VBS).</summary>
235
235
</Docs>
236
236
</Member>
237
237
<MemberMemberName="UsePerBootKey">
@@ -257,7 +257,9 @@
257
257
</ReturnValue>
258
258
<MemberValue>262144</MemberValue>
259
259
<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 <seecref="F:System.Security.Cryptography.CngKeyCreationOptions.RequireVbs" /> or <seecref="F:System.Security.Cryptography.CngKeyCreationOptions.PreferVbs" />.</para>
<paramname="providerName">The name of the <code>OSSL_PROVIDER</code> to process the key open request.</param>
264
+
<paramname="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 <paramrefname="providerName" /> and <paramrefname="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 <paramrefname="keyUri" /> is determined by each individual named <code>OSSL_PROVIDER</code>.</para>
271
+
</remarks>
272
+
<exceptioncref="T:System.ArgumentNullException">
273
+
<paramrefname="providerName" /> or <paramrefname="keyUri" /> is <seelangword="null" />.</exception>
274
+
<exceptioncref="T:System.ArgumentException">
275
+
<paramrefname="providerName" /> or <paramrefname="keyUri" /> is the empty string.</exception>
276
+
<exceptioncref="T:System.PlatformNotSupportedException">The current platform does not support OpenSSL Providers.</exception>
277
+
<exceptioncref="T:System.Security.Cryptography.CryptographicException">The key could not be opened via the specified named <code>OSSL_PROVIDER</code>.</exception>
0 commit comments