Remove over-specific and incorrect documentation about HMAC key lengths

dotnet / dotnet-api-docs

.NET API reference documentation (.NET 5+, .NET Core, .NET Framework)

https://docs.microsoft.com/dotnet/api/

Other

725 stars 1.56k forks source link

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

Closed vcsjones closed 1 month ago

vcsjones commented 1 month ago

Summary

The documentation for the key length in IncrementalHash.CreateHMAC was incorrect regarding how the key adjustment is done, and used the hash size, not the block size, to indicate when the key would be adjusted.

Based on discussion in https://github.com/dotnet/dotnet-api-docs/issues/8920, the fix is to just remove the erroneous content.

Fixes #8920.

dotnet-policy-service[bot] commented 1 month ago

Tagging subscribers to this area: @dotnet/area-system-security, @vcsjones

learn-build-service-prod[bot] commented 1 month ago

Learn Build status updates of commit 7dff165:

:white_check_mark: Validation status: passed

File	Status	Preview URL	Details
xml/System.Security.Cryptography/IncrementalHash.xml	:white_check_mark:Succeeded	View

For more details, please refer to the build report.

For any questions, please:

Try searching the learn.microsoft.com contributor guides
Post your question in the Learn support channel