X509AsymmetricSecurityKey.GetSignatureFormatter(String) Method

Definition

Namespace:

System.IdentityModel.Tokens

Assembly:

System.IdentityModel.dll

Gets the formatter algorithm for the digital signature.

public:
 override System::Security::Cryptography::AsymmetricSignatureFormatter ^ GetSignatureFormatter(System::String ^ algorithm);

public override System.Security.Cryptography.AsymmetricSignatureFormatter GetSignatureFormatter (string algorithm);

override this.GetSignatureFormatter : string -> System.Security.Cryptography.AsymmetricSignatureFormatter

Public Overrides Function GetSignatureFormatter (algorithm As String) As AsymmetricSignatureFormatter

Parameters

algorithm

String

The formatter algorithm for the digital signature to get an instance of.

Returns

AsymmetricSignatureFormatter

An AsymmetricSignatureDeformatter that represents the formatter algorithm for the digital signature.

Exceptions

NotSupportedException

The X.509 certificate specified in the constructor does not have a private key.

-or-

algorithm is XmlDsigDSAUrl and the private key for the X.509 certificate specified in the constructor is not of type DSA.

-or-

algorithm is XmlDsigRSASHA1Url or RsaSha256Signature and the private key for the X.509 certificate specified in the constructor is not of type RSA.

-or-

algorithm is not supported. The supported algorithms are XmlDsigDSAUrl,

XmlDsigRSASHA1Url, and RsaSha256Signature.

Remarks

Use the XmlDsigDSAUrl, XmlDsigRSASHA1Url or RsaSha256Signature fields to specify the algorithm parameter.

Due to collision problems with SHA1, Microsoft recommends a security model based on SHA256 or better.