CryptoProviderFactory.CreateKeyWrapProvider(SecurityKey, String) Method

Reference

Definition

Namespace:: Microsoft.IdentityModel.Tokens

Assembly:: Microsoft.IdentityModel.Tokens.dll

Package:: Microsoft.IdentityModel.Tokens v7.5.1

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 an instance of KeyWrapProvider for a specific <SecurityKey, Algorithm>.

public virtual Microsoft.IdentityModel.Tokens.KeyWrapProvider CreateKeyWrapProvider (Microsoft.IdentityModel.Tokens.SecurityKey key, string algorithm);

abstract member CreateKeyWrapProvider : Microsoft.IdentityModel.Tokens.SecurityKey * string -> Microsoft.IdentityModel.Tokens.KeyWrapProvider
override this.CreateKeyWrapProvider : Microsoft.IdentityModel.Tokens.SecurityKey * string -> Microsoft.IdentityModel.Tokens.KeyWrapProvider

Public Overridable Function CreateKeyWrapProvider (key As SecurityKey, algorithm As String) As KeyWrapProvider

Parameters

key: SecurityKey

the SecurityKey to use.

algorithm: String

the algorithm to use.

Returns

KeyWrapProvider

an instance of KeyWrapProvider

Exceptions

ArgumentNullException

thrown if algorithm is null or empty.

NotSupportedException

thrown if SecurityKey and algorithm pair are not supported.

InvalidOperationException

thrown if Create(String, Object[]) returns a type not assignable from KeyWrapProvider.

Remarks

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

When finished with the KeyWrapProvider call ReleaseKeyWrapProvider(KeyWrapProvider).

Applies to