ECDiffieHellman.DeriveKeyFromHash Method

Definition

Namespace:

System.Security.Cryptography

Assembly:

System.Security.Cryptography.dll

Performs key derivation using a specified hash algorithm.

Overloads

DeriveKeyFromHash(ECDiffieHellmanPublicKey, HashAlgorithmName)	Performs key derivation using a specified hash algorithm.
DeriveKeyFromHash(ECDiffieHellmanPublicKey, HashAlgorithmName, Byte[], Byte[])	When implemented in a derived class, performs key derivation using a specified hash algorithm with optional prepended or appended data.

DeriveKeyFromHash(ECDiffieHellmanPublicKey, HashAlgorithmName)

Source:

ECDiffieHellman.cs

Performs key derivation using a specified hash algorithm.

public:
 cli::array <System::Byte> ^ DeriveKeyFromHash(System::Security::Cryptography::ECDiffieHellmanPublicKey ^ otherPartyPublicKey, System::Security::Cryptography::HashAlgorithmName hashAlgorithm);

public byte[] DeriveKeyFromHash (System.Security.Cryptography.ECDiffieHellmanPublicKey otherPartyPublicKey, System.Security.Cryptography.HashAlgorithmName hashAlgorithm);

member this.DeriveKeyFromHash : System.Security.Cryptography.ECDiffieHellmanPublicKey * System.Security.Cryptography.HashAlgorithmName -> byte[]

Public Function DeriveKeyFromHash (otherPartyPublicKey As ECDiffieHellmanPublicKey, hashAlgorithm As HashAlgorithmName) As Byte()

Parameters

otherPartyPublicKey

ECDiffieHellmanPublicKey

The other party's public key.

hashAlgorithm

HashAlgorithmName

The hash algorithm to use to derive the key material.

Returns

Byte[]

The hash of the shared secret.

Exceptions

ArgumentException

The curve used by otherPartyPublicKey has a different size than the curve from this key.

-or-

The hashAlgorithm parameter does not specify a hash.

ArgumentNullException

otherPartyPublicKey is null.

CryptographicException

The curve used by otherPartyPublicKey is different than the curve from this key.

-or-

This instance represents only a public key.

Remarks

This overload calls the DeriveKeyFromHash method passing null as the prepend and append values.

DeriveKeyFromHash(ECDiffieHellmanPublicKey, HashAlgorithmName, Byte[], Byte[])

Source:

ECDiffieHellman.cs

When implemented in a derived class, performs key derivation using a specified hash algorithm with optional prepended or appended data.

public:
 virtual cli::array <System::Byte> ^ DeriveKeyFromHash(System::Security::Cryptography::ECDiffieHellmanPublicKey ^ otherPartyPublicKey, System::Security::Cryptography::HashAlgorithmName hashAlgorithm, cli::array <System::Byte> ^ secretPrepend, cli::array <System::Byte> ^ secretAppend);

public virtual byte[] DeriveKeyFromHash (System.Security.Cryptography.ECDiffieHellmanPublicKey otherPartyPublicKey, System.Security.Cryptography.HashAlgorithmName hashAlgorithm, byte[]? secretPrepend, byte[]? secretAppend);

abstract member DeriveKeyFromHash : System.Security.Cryptography.ECDiffieHellmanPublicKey * System.Security.Cryptography.HashAlgorithmName * byte[] * byte[] -> byte[]
override this.DeriveKeyFromHash : System.Security.Cryptography.ECDiffieHellmanPublicKey * System.Security.Cryptography.HashAlgorithmName * byte[] * byte[] -> byte[]

Public Overridable Function DeriveKeyFromHash (otherPartyPublicKey As ECDiffieHellmanPublicKey, hashAlgorithm As HashAlgorithmName, secretPrepend As Byte(), secretAppend As Byte()) As Byte()

Parameters

otherPartyPublicKey

ECDiffieHellmanPublicKey

The other party's public key.

hashAlgorithm

HashAlgorithmName

The hash algorithm to use to derive the key material.

secretPrepend

Byte[]

A value to prepend to the derived secret before hashing.

secretAppend

Byte[]

A value to append to the derived secret before hashing.

Returns

Byte[]

The hash of the shared secret after prepending or appending data as requested.

Exceptions

NotImplementedException

A derived class must override this method.

ArgumentException

The curve used by otherPartyPublicKey has a different size than the curve from this key.

-or-

The hashAlgorithm parameter does not specify a hash.

ArgumentNullException

otherPartyPublicKey is null.

CryptographicException

The curve used by otherPartyPublicKey is different than the curve from this key.

-or-

This instance represents only a public key.

Remarks

This method internally performs the Elliptic Curve Diffie-Hellman key agreement to produce the shared secret (z). The return value from this method is the result of HASH(secretPrepend || z || secretAppend) using the specified hash algorithm, where || signifies concatenation.

If the value of secretPrepend or secretAppend is null, they are treated as empty arrays.