Skip to content

Port System.Security.Cryptography docs for .NET 9 #10360

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Sep 5, 2024
Merged

Port System.Security.Cryptography docs for .NET 9 #10360

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6f3c7ee
Add missing System.Security.Cryptography documentation for .NET 9
vcsjones Sep 4, 2024
7e2b999
Manual fixes
vcsjones Sep 4, 2024
0fd356f
Update xml/System.Security.Cryptography/SafeEvpPKeyHandle.xml
vcsjones Sep 4, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions xml/System.Security.Cryptography/CngKeyCreationOptions.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -205,7 +205,7 @@
</ReturnValue>
<MemberValue>65536</MemberValue>
<Docs>
<summary>To be added.</summary>
<summary>Indicates a key should be protected with Virtualization-based security (VBS).</summary>
</Docs>
</Member>
<Member MemberName="RequireVbs">
Expand All @@ -231,7 +231,7 @@
</ReturnValue>
<MemberValue>131072</MemberValue>
<Docs>
<summary>To be added.</summary>
<summary>Indicates a key must be protected with Virtualization-based security (VBS).</summary>
</Docs>
</Member>
<Member MemberName="UsePerBootKey">
Expand All @@ -257,7 +257,9 @@
</ReturnValue>
<MemberValue>262144</MemberValue>
<Docs>
<summary>To be added.</summary>
<summary>
<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>
</summary>
</Docs>
</Member>
</Members>
Expand Down
20 changes: 15 additions & 5 deletions xml/System.Security.Cryptography/SafeEvpPKeyHandle.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -260,11 +260,21 @@
<Parameter Name="keyUri" Type="System.String" Index="1" FrameworkAlternate="net-9.0" />
</Parameters>
<Docs>
<param name="providerName">To be added.</param>
<param name="keyUri">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<param name="providerName">The name of the <code>OSSL_PROVIDER</code> to process the key open request.</param>
<param name="keyUri">The URI assigned by the <code>OSSL_PROVIDER</code> of the key to open.</param>
<summary>Open a named key using a named <code>OSSL_PROVIDER</code>.</summary>
<returns>The opened key.</returns>
<remarks>
<para>Both <paramref name="providerName" /> and <paramref name="keyUri" /> must be trusted inputs.</para>
<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>
<para>The syntax for <paramref name="keyUri" /> is determined by each individual named <code>OSSL_PROVIDER</code>.</para>
</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="providerName" /> or <paramref name="keyUri" /> is <see langword="null" />.</exception>
<exception cref="T:System.ArgumentException">
<paramref name="providerName" /> or <paramref name="keyUri" /> is the empty string.</exception>
<exception cref="T:System.PlatformNotSupportedException">The current platform does not support OpenSSL Providers.</exception>
<exception cref="T:System.Security.Cryptography.CryptographicException">The key could not be opened via the specified named <code>OSSL_PROVIDER</code>.</exception>
</Docs>
</Member>
<Member MemberName="OpenPrivateKeyFromEngine">
Expand Down