Saml2SecurityTokenHandler.ReadSigningKeyInfo 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.]

Deserializes the SAML Signing KeyInfo.

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

Usage

'Usage
Dim reader As XmlReader
Dim assertion As Saml2Assertion
Dim returnValue As SecurityKeyIdentifier

returnValue = Me.ReadSigningKeyInfo(reader, assertion)

Syntax

'Declaration
Protected Overridable Function ReadSigningKeyInfo ( _
    reader As XmlReader, _
    assertion As Saml2Assertion _
) As SecurityKeyIdentifier

protected virtual SecurityKeyIdentifier ReadSigningKeyInfo (
    XmlReader reader,
    Saml2Assertion assertion
)

protected:
virtual SecurityKeyIdentifier^ ReadSigningKeyInfo (
    XmlReader^ reader, 
    Saml2Assertion^ assertion
)

protected SecurityKeyIdentifier ReadSigningKeyInfo (
    XmlReader reader, 
    Saml2Assertion assertion
)

protected function ReadSigningKeyInfo (
    reader : XmlReader, 
    assertion : Saml2Assertion
) : SecurityKeyIdentifier

Parameters

reader
An XmlReader that can be positioned at a ds:KeyInfo element.

assertion
The assertion that is having the signature checked.

Return Value

The SecurityKeyIdentifier that represents the key to use to check the signature.

Exceptions

Exception type	Condition
ArgumentNullException	reader is null.

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)