Provide System.Security.Cryptography.ProtectedData package readme #93660
Conversation
|
Tagging subscribers to this area: @dotnet/area-system-security, @bartonjs, @vcsjones Issue DetailsFill out details for the See #92228
|
src/libraries/System.Security.Cryptography.ProtectedData/src/PACKAGE.md
Outdated
Show resolved
Hide resolved
src/libraries/System.Security.Cryptography.ProtectedData/src/PACKAGE.md
Outdated
Show resolved
Hide resolved
src/libraries/System.Security.Cryptography.ProtectedData/src/PACKAGE.md
Outdated
Show resolved
Hide resolved
|
|
||
| System.Security.Cryptography.ProtectedData offers a simplified interface for utilizing Microsoft Windows DPAPI's [CryptProtectData](https://learn.microsoft.com/windows/win32/api/dpapi/nf-dpapi-cryptprotectdata) and [CryptUnprotectData](https://learn.microsoft.com/windows/win32/api/dpapi/nf-dpapi-cryptunprotectdata) functions. | ||
|
|
||
| This library is primarily aimed at ensuring the security of critical data, like user credentials or sensitive information, either while storing or transmitting. |
There was a problem hiding this comment.
I'd delete this paragraph entirely.
The plain truth is that it's primarily aimed at people already using it. It's reasonable for storing sensitive data locally, not generally suitable for transmission (except for a domain user sending it to themselves on another computer; or for "give this back to me"), but since it's not cross-plat it's not something that we really push... so... it's there for people who were using ProtectedData in .NET Framework.
There was a problem hiding this comment.
Should we give explicit guidance like that? Sounds almost like "don't introduce new use, consider XYZ instead"
There was a problem hiding this comment.
Removing this statement doesn't hurt the documentation, so I'm fine with it.
There is already a note about the better cross-plat support in System.Security.Cryptography.
|
@adamsitnik / @jozkee please approve the PR if ready. |
src/libraries/System.Security.Cryptography.ProtectedData/src/PACKAGE.md
Outdated
Show resolved
Hide resolved
…3660) * Provide Cryptography.ProtectedData package readme * Processing review comments * Remove paragraph and improve sentence * Improve code sample
Fill out details for the
System.Security.Cryptography.ProtectedDataNuGet package readme.See #92228