Skip to content

Remove over-specific and incorrect documentation about HMAC key lengths #10472

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 1 commit into from
Sep 30, 2024
Merged

Remove over-specific and incorrect documentation about HMAC key lengths #10472

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
10 changes: 2 additions & 8 deletions xml/System.Security.Cryptography/IncrementalHash.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -449,13 +449,7 @@
</Parameters>
<Docs>
<param name="hashAlgorithm">The name of the hash algorithm to perform within the HMAC.</param>
<param name="key">
The secret key for the HMAC. The key can be any length, but a key longer than the output size
of the hash algorithm specified by <paramref name="hashAlgorithm" /> will be hashed (using the
algorithm specified by <paramref name="hashAlgorithm" />) to derive a correctly-sized key. Therefore,
the recommended size of the secret key is the output size of the hash specified by
<paramref name="hashAlgorithm" />.
</param>
<param name="key">The secret key for the HMAC.</param>
<summary>
Create an <see cref="T:System.Security.Cryptography.IncrementalHash" /> for the Hash-based Message Authentication Code (HMAC)
algorithm utilizing the hash algorithm specified by <paramref name="hashAlgorithm" />, and a
Expand Down Expand Up @@ -513,7 +507,7 @@
</Parameters>
<Docs>
<param name="hashAlgorithm">The name of the hash algorithm to perform within the HMAC.</param>
<param name="key">The secret key for the HMAC. The key can be any length, but a key longer than the output size of the hash algorithm specified by <paramref name="hashAlgorithm" /> will be hashed (using the algorithm specified by <paramref name="hashAlgorithm" />) to derive a correctly-sized key. Therefore, the recommended size of the secret key is the output size of the hash specified by <paramref name="hashAlgorithm" />.</param>
<param name="key">The secret key for the HMAC.</param>
<summary>Create an <see cref="T:System.Security.Cryptography.IncrementalHash" /> for the Hash-based Message Authentication Code (HMAC) algorithm utilizing the hash algorithm specified by <paramref name="hashAlgorithm" />, and a key specified by <paramref name="key" />.</summary>
<returns>A hash instance to compute the hash algorithm specified by <paramref name="hashAlgorithm" />.</returns>
<remarks>To be added.</remarks>
Expand Down