CngGcmAuthenticatedEncryptionSettings Class¶
Settings for configuring an authenticated encryption mechanism which uses Windows CNG algorithms in GCM encryption + authentication modes.
- Namespace
Microsoft.AspNetCore.DataProtection.AuthenticatedEncryption
- Assemblies
- Microsoft.AspNetCore.DataProtection
Syntax¶
public sealed class CngGcmAuthenticatedEncryptionSettings : IInternalAuthenticatedEncryptionSettings
-
class
Microsoft.AspNetCore.DataProtection.AuthenticatedEncryption.
CngGcmAuthenticatedEncryptionSettings
Properties¶
-
Microsoft.AspNetCore.DataProtection.AuthenticatedEncryption.CngGcmAuthenticatedEncryptionSettings.
EncryptionAlgorithm
¶ The name of the algorithm to use for symmetric encryption. This property corresponds to the ‘pszAlgId’ parameter of BCryptOpenAlgorithmProvider. This property is required to have a value.
Return type: System.String public string EncryptionAlgorithm { get; set; }
-
Microsoft.AspNetCore.DataProtection.AuthenticatedEncryption.CngGcmAuthenticatedEncryptionSettings.
EncryptionAlgorithmKeySize
¶ The length (in bits) of the key that will be used for symmetric encryption. This property is required to have a value.
Return type: System.Int32 public int EncryptionAlgorithmKeySize { get; set; }
-
Microsoft.AspNetCore.DataProtection.AuthenticatedEncryption.CngGcmAuthenticatedEncryptionSettings.
EncryptionAlgorithmProvider
¶ The name of the provider which contains the implementation of the symmetric encryption algorithm. This property corresponds to the ‘pszImplementation’ parameter of BCryptOpenAlgorithmProvider. This property is optional.
Return type: System.String public string EncryptionAlgorithmProvider { get; set; }
-
Methods¶
-
Validate
()¶ Validates that this
Microsoft.AspNetCore.DataProtection.AuthenticatedEncryption.CngGcmAuthenticatedEncryptionSettings
is well-formed, i.e., that the specified algorithm actually exists and can be instantiated properly. An exception will be thrown if validation fails.public void Validate()
-