Saml2SecurityTokenHandler.GetSigningCredentials Method

Article
10/05/2012

[Starting with the .NET Framework 4.5, Windows Identity Foundation (WIF) has been fully integrated into the .NET Framework. The version of WIF addressed by this topic, WIF 3.5, is deprecated and should only be used when developing against the .NET Framework 3.5 SP1 or the .NET Framework 4. For more information about WIF in the .NET Framework 4.5, also known as WIF 4.5, see the Windows Identity Foundation documentation in the .NET Framework 4.5 Development Guide.]

Gets the credentials for signing the assertion.

Namespace: Microsoft.IdentityModel.Tokens.Saml2
Assembly: Microsoft.IdentityModel (in Microsoft.IdentityModel.dll)

Usage

'Usage
Dim tokenDescriptor As SecurityTokenDescriptor
Dim returnValue As SigningCredentials

returnValue = Me.GetSigningCredentials(tokenDescriptor)

Syntax

'Declaration
Protected Overridable Function GetSigningCredentials ( _
    tokenDescriptor As SecurityTokenDescriptor _
) As SigningCredentials

protected virtual SigningCredentials GetSigningCredentials (
    SecurityTokenDescriptor tokenDescriptor
)

protected:
virtual SigningCredentials^ GetSigningCredentials (
    SecurityTokenDescriptor^ tokenDescriptor
)

protected SigningCredentials GetSigningCredentials (
    SecurityTokenDescriptor tokenDescriptor
)

protected function GetSigningCredentials (
    tokenDescriptor : SecurityTokenDescriptor
) : SigningCredentials

Parameters

tokenDescriptor
The token descriptor.

Return Value

A SigningCredentials that represents the credentials for signing the assertion.

Exceptions

Exception type	Condition
ArgumentNullException	tokenDescriptor is null.

Remarks

SAML2 assertions used as security tokens should be signed.

The default implementation uses the SigningCredentials property of the tokenDescriptor to retrieve the credentials.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Platforms

Target Platforms

Windows 7, Windows Server 2008 R2, Windows Vista SP2, Windows Server 2008 SP2, Windows Server 2003 SP2 (32-bit or 64-bit)