CryptoProviderFactory.CreateAuthenticatedEncryptionProvider 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 AuthenticatedEncryptionProvider for a specific <SecurityKey, 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 SecurityKey and algorithm pair are not supported.

InvalidOperationException

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

Remarks

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

When finished with the KeyWrapProvider call ReleaseKeyWrapProvider(KeyWrapProvider).

Applies to

Share via