CryptoProviderFactory.CreateForVerifying Method

Definition

Namespace:

Microsoft.IdentityModel.Tokens

Assembly:

Microsoft.IdentityModel.Tokens.dll

Package:

Microsoft.IdentityModel.Tokens v7.6.2

Overloads

CreateForVerifying(SecurityKey, String)	Creates a SignatureProvider that supports the SecurityKey and algorithm.
CreateForVerifying(SecurityKey, String, Boolean)	Creates a SignatureProvider that supports the SecurityKey and algorithm.

CreateForVerifying(SecurityKey, String)

Creates a SignatureProvider that supports the SecurityKey and algorithm.

public virtual Microsoft.IdentityModel.Tokens.SignatureProvider CreateForVerifying (Microsoft.IdentityModel.Tokens.SecurityKey key, string algorithm);

abstract member CreateForVerifying : Microsoft.IdentityModel.Tokens.SecurityKey * string -> Microsoft.IdentityModel.Tokens.SignatureProvider
override this.CreateForVerifying : Microsoft.IdentityModel.Tokens.SecurityKey * string -> Microsoft.IdentityModel.Tokens.SignatureProvider

Public Overridable Function CreateForVerifying (key As SecurityKey, algorithm As String) As SignatureProvider

Parameters

key

SecurityKey

The SecurityKey to use for signature verification.

algorithm

String

The algorithm to use for verifying.

Returns

SignatureProvider

A SignatureProvider that can be used to validate a signature using the SecurityKey and algorithm.

Exceptions

ArgumentNullException

thrown if algorithm is null or empty.

ArgumentOutOfRangeException

thrown if KeySize is too small.

NotSupportedException

thrown if the key / algorithm is not supported.

InvalidOperationException

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

Remarks

When finished with the SignatureProvider call ReleaseSignatureProvider(SignatureProvider).

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

CreateForVerifying(SecurityKey, String, Boolean)

Creates a SignatureProvider that supports the SecurityKey and algorithm.

public virtual Microsoft.IdentityModel.Tokens.SignatureProvider CreateForVerifying (Microsoft.IdentityModel.Tokens.SecurityKey key, string algorithm, bool cacheProvider);

abstract member CreateForVerifying : Microsoft.IdentityModel.Tokens.SecurityKey * string * bool -> Microsoft.IdentityModel.Tokens.SignatureProvider
override this.CreateForVerifying : Microsoft.IdentityModel.Tokens.SecurityKey * string * bool -> Microsoft.IdentityModel.Tokens.SignatureProvider

Public Overridable Function CreateForVerifying (key As SecurityKey, algorithm As String, cacheProvider As Boolean) As SignatureProvider

Parameters

key

SecurityKey

The SecurityKey to use for signature verification.

algorithm

String

The algorithm to use for verifying.

cacheProvider

Boolean

should the SignatureProvider be cached.

Returns

SignatureProvider

A SignatureProvider that can be used to validate a signature using the SecurityKey and algorithm.

Exceptions

ArgumentNullException

thrown if algorithm is null or empty.

ArgumentOutOfRangeException

thrown if KeySize is too small.

NotSupportedException

thrown if the key / algorithm is not supported.

InvalidOperationException

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

Remarks

When finished with the SignatureProvider call ReleaseSignatureProvider(SignatureProvider).

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