SignatureProviderFactory.CreateForSigning Method
Creates a SignatureProvider that supports the SecurityKey and algorithm.
Namespace: System.IdentityModel.Tokens
Assembly: System.IdentityModel.Tokens.Jwt (in System.IdentityModel.Tokens.Jwt.dll)
Syntax
'Declaration
Public Overridable Function CreateForSigning ( _
key As SecurityKey, _
algorithm As String _
) As SignatureProvider
public virtual SignatureProvider CreateForSigning(
SecurityKey key,
string algorithm
)
public:
virtual SignatureProvider^ CreateForSigning(
SecurityKey^ key,
String^ algorithm
)
abstract CreateForSigning :
key:SecurityKey *
algorithm:string -> SignatureProvider
override CreateForSigning :
key:SecurityKey *
algorithm:string -> SignatureProvider
public function CreateForSigning(
key : SecurityKey,
algorithm : String
) : SignatureProvider
Parameters
- key
Type: System.IdentityModel.Tokens.SecurityKey
- algorithm
Type: System.String
Return Value
Type: System.IdentityModel.Tokens.SignatureProvider
Returns SignatureProvider.
Exceptions
| Exception | Condition |
|---|---|
| ArgumentNullException | 'key' is null. -or- 'algorithm' is null. |
| ArgumentException | 'algorithm' contains only whitespace. -or- 'SecurityKey' is not a AsymmetricSecurityKey or a SymmetricSecurityKey. |
| ArgumentOutOfRangeException | 'AsymmetricSecurityKey' is smaller than MinimumAsymmetricKeySizeInBitsForSigning. -or- 'SymmetricSecurityKey' is smaller than MinimumSymmetricKeySizeInBits. |
Remarks
AsymmetricSignatureProviders require access to a PrivateKey for Signing.
.NET Framework Security
- Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.