dotnet / dotnet/dotnet-api-docs

Update Rfc2898DeriveBytes documentation for salt length minimums NET5-/NET6+

Open
#6,996 0 comments 0 reactions 0 assignees View on GitHub
area-System.Runtime Pri3 untriaged
Dominant language
C#
Stars
949
Forks
1.7k
Avg merge
3d 27m
Merged PRs (30d)
49

Description

https://github.com/dotnet/runtime/pull/57006 is about to remove the minimum length checks for the salt array.

https://github.com/dotnet/dotnet-api-docs/blob/main/xml/System.Security.Cryptography/Rfc2898DeriveBytes.xml#L129-L152 (and the other overloads) mention this minimum in both the exception descriptions and the remarks.

I'm guessing the exception text would be something like
```diff
- The specified salt size is smaller than 8 bytes or the iteration count is less than 1.
+ The iteration count is less than 1, or (.NET 5 and older) the specified salt size is smaller than 8 bytes.
```

But that seems a little awkward, so maybe the right answer is a more complex split.

Since it doesn't seem obvious to me, I decided to create the tracking issue rather than just attempt something.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.