This documentation is archived and is not being maintained.

SecurityTokenProvider Class

Represents a security token provider that handles security tokens for a SOAP message sender.

Namespace:  System.IdentityModel.Selectors
Assembly:  System.IdentityModel (in System.IdentityModel.dll)

Public MustInherit Class SecurityTokenProvider
Dim instance As SecurityTokenProvider

Use the SecurityTokenProvider class when custom security tokens are required. The role of a security token provider is to get a security token when a SOAP message is sent by a client and a security token is used to authenticate the client or to protect the SOAP message. Specifically, the GetToken method is called to get a security token. The security token provider can also be called to cancel and renew a security using the CancelToken and RenewToken methods.

Classes that derive from the SecurityTokenManager class implement the CreateSecurityTokenProvider method to determine which security token provider is required for a given security token.

The ClientCredentialsSecurityTokenManager and ServiceCredentialsSecurityTokenManager classes provide the default implementations for built-in security token types. For custom security token scenarios, you must derive a class from one of the SecurityTokenManager, ClientCredentialsSecurityTokenManager, or ServiceCredentialsSecurityTokenManager classes and provide the functionality to create the security token provider, security token authenticator, and security token serializer for the custom security token. For more information about creating a custom token, see How To: Create a Custom Token.

Imports System

Imports System.IdentityModel.Selectors
Imports System.IdentityModel.Tokens

Imports System.IO

Imports System.ServiceModel.Security

Imports System.Xml

'/ <summary> 
'/ class that derives from SecurityTokenProvider and returns a SecurityToken representing a SAML assertion 
'/ </summary> 

Public Class SamlSecurityTokenProvider
    Inherits SecurityTokenProvider
    '/ <summary> 
    '/ The SAML assertion that the SamlSecurityTokenProvider will return as a SecurityToken 
    '/ </summary> 
    Private assertion As SamlAssertion

    '/ <summary> 
    '/ The proof token associated with the SAML assertion 
    '/ </summary> 
    Private proofToken As SecurityToken

    '/ <summary> 
    '/ Constructor 
    '/ </summary> 
    '/ <param name="assertion">The SAML assertion that the SamlSecurityTokenProvider will return as a SecurityToken</param> 
    '/ <param name="proofToken">The proof token associated with the SAML assertion</param> 
    Public Sub New(ByVal assertion As SamlAssertion, ByVal proofToken As SecurityToken)
        Me.assertion = assertion
        Me.proofToken = proofToken

    End Sub 'New 

    '/ <summary> 
    '/ Creates the security token 
    '/ </summary> 
    '/ <param name="timeout">Maximum amount of time the method is supposed to take. Ignored in this implementation.</param> 
    '/ <returns>A SecurityToken corresponding the SAML assertion and proof key specified at construction time</returns> 
    Protected Overrides Function GetTokenCore(ByVal timeout As TimeSpan) As SecurityToken
        ' Create a SamlSecurityToken from the provided assertion 
        Dim samlToken As New SamlSecurityToken(assertion)

        ' Create a SecurityTokenSerializer that will be used to serialize the SamlSecurityToken 
        Dim ser As New WSSecurityTokenSerializer()

        ' Create a memory stream to write the serialized token into 
        ' Use an initial size of 64Kb 
        Dim s As New MemoryStream(UInt16.MaxValue)

        ' Create an XmlWriter over the stream 
        Dim xw As XmlWriter = XmlWriter.Create(s)

        ' Write the SamlSecurityToken into the stream
        ser.WriteToken(xw, samlToken)

        ' Seek back to the beginning of the stream
        s.Seek(0, SeekOrigin.Begin)

        ' Load the serialized token into a DOM 
        Dim dom As New XmlDocument()

        ' Create a KeyIdentifierClause for the SamlSecurityToken 
        Dim samlKeyIdentifierClause As SamlAssertionKeyIdentifierClause = samlToken.CreateKeyIdentifierClause(Of SamlAssertionKeyIdentifierClause)()

        ' Return a GenericXmlToken from the XML for the SamlSecurityToken, the proof token, the valid from  
        ' and valid until times from the assertion and the key identifier clause created above             
        Return New GenericXmlSecurityToken(dom.DocumentElement, proofToken, assertion.Conditions.NotBefore, assertion.Conditions.NotOnOrAfter, samlKeyIdentifierClause, samlKeyIdentifierClause, Nothing)

    End Function 'GetTokenCore

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

Windows 7, Windows Vista, Windows XP SP2, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

.NET Framework

Supported in: 3.5, 3.0