SecurityTokenProvider Class
Represents a security token provider that handles security tokens for a SOAP message sender.
System.IdentityModel.Selectors.SecurityTokenProvider
System.IdentityModel.Selectors.KerberosSecurityTokenProvider
System.IdentityModel.Selectors.UserNameSecurityTokenProvider
System.IdentityModel.Selectors.X509SecurityTokenProvider
System.ServiceModel.Security.SspiSecurityTokenProvider
System.ServiceModel.Security.Tokens.IssuedSecurityTokenProvider
Assembly: System.IdentityModel (in System.IdentityModel.dll)
The SecurityTokenProvider type exposes the following members.
| Name | Description | |
|---|---|---|
![]() | SecurityTokenProvider | Initializes a new instance of the SecurityTokenProvider class. |
| Name | Description | |
|---|---|---|
![]() | SupportsTokenCancellation | Gets a value that indicates whether the security token can be cancelled. |
![]() | SupportsTokenRenewal | Gets a value that indicates whether the security token is renewable. |
| Name | Description | |
|---|---|---|
![]() | BeginCancelToken | Begins an asynchronous operation to cancel a security token. |
![]() | BeginCancelTokenCore | Begins an asynchronous operation to cancel a security token. |
![]() | BeginGetToken | Begins an asynchronous operation to get a security token. |
![]() | BeginGetTokenCore | Begins an asynchronous operation to get a security token. |
![]() | BeginRenewToken | Begins an asynchronous operation that renews a security token. |
![]() | BeginRenewTokenCore | Begins an asynchronous operation that renews a security token. |
![]() | CancelToken | Cancels a security token. |
![]() | CancelTokenCore | Cancels a security token. |
![]() | EndCancelToken | Completes an asynchronous operation to cancel a security token. |
![]() | EndCancelTokenCore | Completes an asynchronous operation to cancel a security token. |
![]() | EndGetToken | Completes an asynchronous operation to get a security token. |
![]() | EndGetTokenCore | Completes an asynchronous operation to get a security token. |
![]() | EndRenewToken | Completes an asynchronous operation to renew a security token. |
![]() | EndRenewTokenCore | Completes an asynchronous operation to renew the security token. |
![]() | Equals(Object) | Determines whether the specified Object is equal to the current Object. (Inherited from Object.) |
![]() | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
![]() | GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
![]() | GetToken | Gets a security token. |
![]() | GetTokenCore | Gets a security token. |
![]() | GetType | Gets the Type of the current instance. (Inherited from Object.) |
![]() | MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
![]() | RenewToken | Renews a security token. |
![]() | RenewTokenCore | Renews a security token. |
![]() | ToString | Returns a string that represents the current object. (Inherited from Object.) |
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() dom.Load(s) ' 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
Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2
The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
