CryptoProviderFactory.CreateKeyedHashAlgorithm(Byte[], String) Method

Reference

Definition

Namespace:: Microsoft.IdentityModel.Tokens

Assembly:: Microsoft.IdentityModel.Tokens.dll

Package:: Microsoft.IdentityModel.Tokens v8.2.0

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Creates a KeyedHashAlgorithm instance for a specific keyed hash algorithm.

public virtual System.Security.Cryptography.KeyedHashAlgorithm CreateKeyedHashAlgorithm (byte[] keyBytes, string algorithm);

abstract member CreateKeyedHashAlgorithm : byte[] * string -> System.Security.Cryptography.KeyedHashAlgorithm
override this.CreateKeyedHashAlgorithm : byte[] * string -> System.Security.Cryptography.KeyedHashAlgorithm

Public Overridable Function CreateKeyedHashAlgorithm (keyBytes As Byte(), algorithm As String) As KeyedHashAlgorithm

Parameters

keyBytes: Byte[]

The bytes to use as the key for the keyed hash.

algorithm: String

The name of the keyed hash algorithm to create.

Returns

KeyedHashAlgorithm

A KeyedHashAlgorithm instance that corresponds to the specified algorithm.

Exceptions

ArgumentNullException

Thrown if algorithm is null or empty.

InvalidOperationException

Thrown if Create(String, Object[]) returns a type that is not assignable to KeyedHashAlgorithm.

NotSupportedException

Thrown if algorithm is not supported.

Remarks

Once done with the KeyedHashAlgorithm, call ReleaseHashAlgorithm(HashAlgorithm).

If CustomCryptoProvider is set and IsSupportedAlgorithm(String, Object[]) returns true, Create(String, Object[]) is called to obtain the KeyedHashAlgorithm.

Applies to

Share via