CryptoProviderFactory.CreateAuthenticatedEncryptionProvider 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 an instance of AuthenticatedEncryptionProvider for a specific key and algorithm.

public virtual Microsoft.IdentityModel.Tokens.AuthenticatedEncryptionProvider CreateAuthenticatedEncryptionProvider (Microsoft.IdentityModel.Tokens.SecurityKey key, string algorithm);

abstract member CreateAuthenticatedEncryptionProvider : Microsoft.IdentityModel.Tokens.SecurityKey * string -> Microsoft.IdentityModel.Tokens.AuthenticatedEncryptionProvider
override this.CreateAuthenticatedEncryptionProvider : Microsoft.IdentityModel.Tokens.SecurityKey * string -> Microsoft.IdentityModel.Tokens.AuthenticatedEncryptionProvider

Public Overridable Function CreateAuthenticatedEncryptionProvider (key As SecurityKey, algorithm As String) As AuthenticatedEncryptionProvider

Parameters

key: SecurityKey

The SecurityKey to use.

algorithm: String

The algorithm to use.

Returns

AuthenticatedEncryptionProvider

An instance of AuthenticatedEncryptionProvider.

Exceptions

ArgumentNullException

Thrown if algorithm is null or empty.

ArgumentException

Thrown if the combination of key and algorithm is not supported.

InvalidOperationException

Thrown if the type returned by Create(String, Object[]) is not assignable to KeyWrapProvider.

Remarks

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

Once done with the KeyWrapProvider, call ReleaseKeyWrapProvider(KeyWrapProvider).

Applies to

Share via