Skip to content

Document 2 APIs in System.Security.Cryptography.DCACng #2968

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
Aug 8, 2019
Merged

Document 2 APIs in System.Security.Cryptography.DCACng #2968

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1aa6a7b
Document 2 APIs in System.Security.Cryptography.DSACng
carlossanlop Aug 8, 2019
d8b4151
suggestions
carlossanlop Aug 8, 2019
8f36009
suggestion by mairaw
carlossanlop Aug 8, 2019
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
33 changes: 15 additions & 18 deletions xml/System.Security.Cryptography/DSACng.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -171,10 +171,8 @@
<summary>Creates the digital signature for the specified data.</summary>
<returns>The digital signature for the specified data.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="rgbHash" /> is <see langword="null" />.</exception>
<exception cref="T:System.PlatformNotSupportedException">
<paramref name="rgbHash" /> is shorter in length than the Q value of the DSA key .</exception>
<exception cref="T:System.ArgumentNullException"><paramref name="rgbHash" /> is <see langword="null" />.</exception>
<exception cref="T:System.PlatformNotSupportedException"><paramref name="rgbHash" /> is shorter in length than the Q value of the DSA key .</exception>
</Docs>
</Member>
<Member MemberName="Dispose">
Expand Down Expand Up @@ -485,11 +483,11 @@
<Parameter Name="bytesWritten" Type="System.Int32" RefType="out" Index="2" FrameworkAlternate="netcore-3.0" />
</Parameters>
<Docs>
<param name="hash">To be added.</param>
<param name="destination">To be added.</param>
<param name="bytesWritten">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="hash">A read-only span of bytes containing a hash of the data to be signed.</param>
<param name="destination">The buffer where the digital signature is to be written.</param>
<param name="bytesWritten">When this method returns, the number of bytes that were written in <paramref name="destination" />.</param>
<summary>Tries to create the digital signature for the specified data.</summary>
<returns><see langword="true" /> if the digital signature was created successfully; <see langword="false" /> if the <paramref name="destination" /> buffer was too small.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -561,16 +559,14 @@
<param name="rgbHash">The signed data.</param>
<param name="rgbSignature">The digital signature to be verified.</param>
<summary>Verifies if the specified digital signature matches the specified data.</summary>
<returns>
<see langword="true" /> if <paramref name="rgbSignature" /> matches the signature computed using the specified data; otherwise, <see langword="false" />.</returns>
<returns><see langword="true" /> if <paramref name="rgbSignature" /> matches the signature computed using the specified data; otherwise, <see langword="false" />.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">The <paramref name="rgbHash" /> parameter is <see langword="null" />.

-or-

The <paramref name="rgbSignature" /> parameter is <see langword="null" />.</exception>
<exception cref="T:System.PlatformNotSupportedException">
<paramref name="rgbHash" /> is shorter in length than the Q value of the DSA key .</exception>
<exception cref="T:System.PlatformNotSupportedException"><paramref name="rgbHash" /> is shorter in length than the Q value of the DSA key.</exception>
</Docs>
</Member>
<Member MemberName="VerifySignature">
Expand All @@ -596,12 +592,13 @@
<Parameter Name="signature" Type="System.ReadOnlySpan&lt;System.Byte&gt;" Index="1" FrameworkAlternate="netcore-3.0" />
</Parameters>
<Docs>
<param name="hash">To be added.</param>
<param name="signature">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="hash">A read-only span of bytes containing the signed data.</param>
<param name="signature">A read-only span of bytes containing the signature to be verified.</param>
<summary>Verifies if the specified digital signature matches the specified data.</summary>
<returns><see langword="true" /> if <paramref name="signature" /> matches the signature computed using the specified data; otherwise, <see langword="false" />.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.PlatformNotSupportedException"><paramref name="hash" /> is shorter in length than the Q value of the DSA key.</exception>
</Docs>
</Member>
</Members>
</Type>
</Type>