Edit

Share via

ECDiffieHellmanKeyDerivationFunction Enum

Definition

Namespace:
System.Security.Cryptography
Assembly:
System.Security.Cryptography.dll
Assembly:
System.Security.Cryptography.Cng.dll
Assemblies:
System.Security.Cryptography.dll, System.Security.Cryptography.Cng.dll
Assembly:
System.Core.dll
Package:
System.Security.Cryptography.Cng v5.0.0
Source:
ECDiffieHellmanKeyDerivationFunction.cs

Specifies the key derivation function that the ECDiffieHellmanCng class will use to convert secret agreements into key material.

C# 
public enum ECDiffieHellmanKeyDerivationFunction
Inheritance
Object
ValueType
Enum
ECDiffieHellmanKeyDerivationFunction

Fields

Name Value Description
Hash 0

A hash algorithm is used to generate key material. The HashAlgorithm property specifies the name of the algorithm to use. If the algorithm name is not specified, SHA256 is used as the default algorithm. You can also specify the SecretPrepend and SecretAppend properties, but they are not required. The amount of key material that is generated is equivalent to the size of the hash value for the specified algorithm.
Hmac 1

A Hash-based Message Authentication Code (HMAC) algorithm is used to generate key material. The HmacKey property specifies the key to use. Either this property must be set or the UseSecretAgreementAsHmacKey property must be set to true; otherwise, a CryptographicException is thrown when you use Hmac. If both properties are set, the secret agreement is used as the HMAC key. You can also specify the SecretPrepend and SecretAppend properties, but they are not required. The amount of key material that is generated is equivalent to the size of the HMAC value.
Tls 2

The Transport Layer Security (TLS) protocol is used to generate key material. The Seed and Label properties must be set; otherwise, a CryptographicException is thrown when you use Tls. This value generates 160 bits of key material.

Remarks

The ECDiffieHellmanKeyDerivationFunction enumeration defines the type of algorithm that will be used to transform a raw secret agreement into key material. The secret agreement is the value that is generated from a private key and the other party's public key, as part of the key exchange. It is the seed value for the key material that is generated by the ECDiffieHellmanCng.DeriveKeyMaterial method.

The ECDiffieHellmanCng.KeyDerivationFunction property uses this enumeration to get the key derivation function for the ECDiffieHellmanCng class.

Applies to

Product Versions
.NET 6, 7, 8, 9, 10
.NET Framework 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2 (package-provided), 4.7.2, 4.8 (package-provided), 4.8, 4.8.1
.NET Standard 2.1 (package-provided)
Windows Desktop 3.0, 3.1, 5