IncrementalHash.CreateHMAC Method

Definition

Namespace:

System.Security.Cryptography

Assembly:

System.Security.Cryptography.dll

Overloads

CreateHMAC(HashAlgorithmName, Byte[])	Create an IncrementalHash for the Hash-based Message Authentication Code (HMAC) algorithm utilizing the hash algorithm specified by hashAlgorithm, and a key specified by key.
CreateHMAC(HashAlgorithmName, ReadOnlySpan<Byte>)	Create an IncrementalHash for the Hash-based Message Authentication Code (HMAC) algorithm utilizing the hash algorithm specified by hashAlgorithm, and a key specified by key.

CreateHMAC(HashAlgorithmName, Byte[])

Source:

IncrementalHash.cs

Create an IncrementalHash for the Hash-based Message Authentication Code (HMAC) algorithm utilizing the hash algorithm specified by hashAlgorithm, and a key specified by key.

public:
 static System::Security::Cryptography::IncrementalHash ^ CreateHMAC(System::Security::Cryptography::HashAlgorithmName hashAlgorithm, cli::array <System::Byte> ^ key);

public static System.Security.Cryptography.IncrementalHash CreateHMAC (System.Security.Cryptography.HashAlgorithmName hashAlgorithm, byte[] key);

static member CreateHMAC : System.Security.Cryptography.HashAlgorithmName * byte[] -> System.Security.Cryptography.IncrementalHash

Public Shared Function CreateHMAC (hashAlgorithm As HashAlgorithmName, key As Byte()) As IncrementalHash

Parameters

hashAlgorithm

HashAlgorithmName

The name of the hash algorithm to perform within the HMAC.

key

Byte[]

The secret key for the HMAC. The key can be any length, but a key longer than the output size of the hash algorithm specified by hashAlgorithm will be hashed (using the algorithm specified by hashAlgorithm) to derive a correctly-sized key. Therefore, the recommended size of the secret key is the output size of the hash specified by hashAlgorithm.

Returns

IncrementalHash

An IncrementalHash instance ready to compute the hash algorithm specified by hashAlgorithm.

Exceptions

ArgumentNullException

key is null.

ArgumentException

hashAlgorithm.Name is null, or the empty string.

CryptographicException

hashAlgorithm is not a known hash algorithm.

CreateHMAC(HashAlgorithmName, ReadOnlySpan<Byte>)

Source:

IncrementalHash.cs

Create an IncrementalHash for the Hash-based Message Authentication Code (HMAC) algorithm utilizing the hash algorithm specified by hashAlgorithm, and a key specified by key.

public:
 static System::Security::Cryptography::IncrementalHash ^ CreateHMAC(System::Security::Cryptography::HashAlgorithmName hashAlgorithm, ReadOnlySpan<System::Byte> key);

public static System.Security.Cryptography.IncrementalHash CreateHMAC (System.Security.Cryptography.HashAlgorithmName hashAlgorithm, ReadOnlySpan<byte> key);

static member CreateHMAC : System.Security.Cryptography.HashAlgorithmName * ReadOnlySpan<byte> -> System.Security.Cryptography.IncrementalHash

Public Shared Function CreateHMAC (hashAlgorithm As HashAlgorithmName, key As ReadOnlySpan(Of Byte)) As IncrementalHash

Parameters

hashAlgorithm

HashAlgorithmName

The name of the hash algorithm to perform within the HMAC.

key

ReadOnlySpan<Byte>

The secret key for the HMAC. The key can be any length, but a key longer than the output size of the hash algorithm specified by hashAlgorithm will be hashed (using the algorithm specified by hashAlgorithm) to derive a correctly-sized key. Therefore, the recommended size of the secret key is the output size of the hash specified by hashAlgorithm.

Returns

IncrementalHash

A hash instance to compute the hash algorithm specified by hashAlgorithm.

Exceptions

ArgumentException

hashAlgorithm.Name is null or the empty string.

CryptographicException

hashAlgorithm is not a known hash algorithm.