Saml11SecurityTokenHandler.ProcessSamlSubject 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.]

For each saml statement (attribute/authentication/authz/custom), we will check if we need to create a nameid claim or a key identifier claim out of its SamlSubject.

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

Usage

'Usage
Dim samlSubject As SamlSubject
Dim subject As IClaimsIdentity
Dim issuer As String

Me.ProcessSamlSubject(samlSubject, subject, issuer)

Syntax

'Declaration
Protected Overridable Sub ProcessSamlSubject ( _
    samlSubject As SamlSubject, _
    subject As IClaimsIdentity, _
    issuer As String _
)

protected virtual void ProcessSamlSubject (
    SamlSubject samlSubject,
    IClaimsIdentity subject,
    string issuer
)

protected:
virtual void ProcessSamlSubject (
    SamlSubject^ samlSubject, 
    IClaimsIdentity^ subject, 
    String^ issuer
)

protected void ProcessSamlSubject (
    SamlSubject samlSubject, 
    IClaimsIdentity subject, 
    String issuer
)

protected function ProcessSamlSubject (
    samlSubject : SamlSubject, 
    subject : IClaimsIdentity, 
    issuer : String
)

Parameters

samlSubject
The SamlSubject to extract claims from.

subject
The identity that should be modified to reflect the SamlSubject.

issuer
The Issuer claims of the SAML token.

Exceptions

Exception type	Condition
ArgumentNullException	The parameter 'samlSubject' is null.

Remarks

To make sure that the saml subject within each saml statement are the same, this method does the following comparisons.

1. All the saml subjects' contents are the same.

2. The name identifiers (if present) are the same. The name identifier comparison is done for the name identifier value, name identifier format (if present), and name identifier qualifier (if present).

3. The key identifiers (if present) are the same.

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)