Saml2SecurityTokenHandler.GetEncryptingCredentials 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 token encrypting credentials. Override this method to change the token encrypting credentials.

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

Usage

'Usage
Dim tokenDescriptor As SecurityTokenDescriptor
Dim returnValue As EncryptingCredentials

returnValue = Me.GetEncryptingCredentials(tokenDescriptor)

Syntax

'Declaration
Protected Overridable Function GetEncryptingCredentials ( _
    tokenDescriptor As SecurityTokenDescriptor _
) As EncryptingCredentials

protected virtual EncryptingCredentials GetEncryptingCredentials (
    SecurityTokenDescriptor tokenDescriptor
)

protected:
virtual EncryptingCredentials^ GetEncryptingCredentials (
    SecurityTokenDescriptor^ tokenDescriptor
)

protected EncryptingCredentials GetEncryptingCredentials (
    SecurityTokenDescriptor tokenDescriptor
)

protected function GetEncryptingCredentials (
    tokenDescriptor : SecurityTokenDescriptor
) : EncryptingCredentials

Parameters

tokenDescriptor
Retrieves some scope encrypting credentials from the Scope object.

Return Value

An EncryptingCredentials that represents the token encrypting credentials.

Exceptions

Exception type	Condition
ArgumentNullException	tokenDescriptor is null.
SecurityTokenException	The encrypting credentials retrieved from the token descriptor are asymmetric.

Remarks

The default implementation retrieves the encrypting credentials from the EncryptingCredentials property of the tokenDescriptor.

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)

Share via