Skip to content

Commit 45b1ff3

Browse files
authored
Remove over-specific and incorrect documentation about HMAC key lengths
1 parent 6139eea commit 45b1ff3

File tree

1 file changed

+2
-8
lines changed

1 file changed

+2
-8
lines changed

xml/System.Security.Cryptography/IncrementalHash.xml

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -449,13 +449,7 @@
449449
</Parameters>
450450
<Docs>
451451
<param name="hashAlgorithm">The name of the hash algorithm to perform within the HMAC.</param>
452-
<param name="key">
453-
The secret key for the HMAC. The key can be any length, but a key longer than the output size
454-
of the hash algorithm specified by <paramref name="hashAlgorithm" /> will be hashed (using the
455-
algorithm specified by <paramref name="hashAlgorithm" />) to derive a correctly-sized key. Therefore,
456-
the recommended size of the secret key is the output size of the hash specified by
457-
<paramref name="hashAlgorithm" />.
458-
</param>
452+
<param name="key">The secret key for the HMAC.</param>
459453
<summary>
460454
Create an <see cref="T:System.Security.Cryptography.IncrementalHash" /> for the Hash-based Message Authentication Code (HMAC)
461455
algorithm utilizing the hash algorithm specified by <paramref name="hashAlgorithm" />, and a
@@ -513,7 +507,7 @@
513507
</Parameters>
514508
<Docs>
515509
<param name="hashAlgorithm">The name of the hash algorithm to perform within the HMAC.</param>
516-
<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>
510+
<param name="key">The secret key for the HMAC.</param>
517511
<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>
518512
<returns>A hash instance to compute the hash algorithm specified by <paramref name="hashAlgorithm" />.</returns>
519513
<remarks>To be added.</remarks>

0 commit comments

Comments
 (0)