dotnet / dotnet-api-docs

.NET API reference documentation (.NET 5+, .NET Core, .NET Framework)
https://docs.microsoft.com/dotnet/api/
Other
718 stars 1.56k forks source link

Please provide CipherMode availability matrix #3597

Open lextm opened 6 years ago

lextm commented 6 years ago

https://docs.microsoft.com/en-us/dotnet/api/system.security.cryptography.ciphermode?view=netcore-2.0

The current documentation does not show which cipher modes are supported by a certain algorithm on different platforms. One question I have is that "on which platforms is AES CFB mode fully supported?", that no existing documentation can tell.

Library authors and users are forced to rely on CryptographicException as stated, which is clearly inconvenient.

https://docs.microsoft.com/en-us/dotnet/api/system.security.cryptography.symmetricalgorithm.mode?view=netcore-2.0#System_Security_Cryptography_SymmetricAlgorithm_Mode

I know it is not easy to build a matrix in documentation, as there are multiple platforms, multiple algorithms and cipher modes to check. But I guess your test suite should cover the same things, so the information is already somewhere.

Only if you provide it, library authors and end users can then save tons of hours testing on their own.

richlander commented 6 years ago

I've thought for a while that we need some tables on the full set of options that .NET Core and .NET Framework support.

I'm wondering if CSV is the best source format for this information and then generate the correct markdown.

PTAL @terrajobst @GrabYourPitchforks

mairaw commented 6 years ago

@terrajobst @GrabYourPitchforks @richlander anyone can help with this info so we can add it to the docs?

mairaw commented 6 years ago

@terrajobst @GrabYourPitchforks @richlander pinging again