SecurityTokenProvider Classe

Definição

Namespace:

System.IdentityModel.Selectors

Assembly:

System.ServiceModel.Primitives.dll

Pacote:

System.ServiceModel.Primitives v6.2.0

Origem:

SecurityTokenProvider.cs

Representa um provedor de token de segurança que manipula tokens de segurança para um remetente da mensagem SOAP.

public ref class SecurityTokenProvider abstract

public abstract class SecurityTokenProvider

type SecurityTokenProvider = class

Public MustInherit Class SecurityTokenProvider

Herança

Object

SecurityTokenProvider

Derivado

System.IdentityModel.Selectors.KerberosSecurityTokenProvider

System.IdentityModel.Selectors.UserNameSecurityTokenProvider

System.IdentityModel.Selectors.X509SecurityTokenProvider

System.ServiceModel.Federation.WSTrustChannelSecurityTokenProvider

System.ServiceModel.Security.SimpleSecurityTokenProvider

System.ServiceModel.Security.SspiSecurityTokenProvider

System.ServiceModel.Security.Tokens.IssuedSecurityTokenProvider

Exemplos

using System;

using System.IdentityModel.Selectors;
using System.IdentityModel.Tokens;

using System.IO;

using System.ServiceModel.Security;

using System.Xml;

namespace Microsoft.ServiceModel.Samples
{
    /// <summary>
    /// class that derives from SecurityTokenProvider and returns a SecurityToken representing a SAML assertion
    /// </summary>
    public class SamlSecurityTokenProvider : SecurityTokenProvider
    {
        /// <summary>
        /// The SAML assertion that the SamlSecurityTokenProvider will return as a SecurityToken
        /// </summary>
        SamlAssertion assertion;

        /// <summary>
        /// The proof token associated with the SAML assertion
        /// </summary>
        SecurityToken proofToken;

        /// <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 SamlSecurityTokenProvider(SamlAssertion assertion, SecurityToken proofToken )
        {
            this.assertion = assertion;
            this.proofToken = proofToken;
        }

        /// <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 override SecurityToken GetTokenCore(TimeSpan timeout)
        {
            // Create a SamlSecurityToken from the provided assertion
            SamlSecurityToken samlToken = new SamlSecurityToken(assertion);

            // Create a SecurityTokenSerializer that will be used to serialize the SamlSecurityToken
            WSSecurityTokenSerializer ser = new WSSecurityTokenSerializer();

            // Create a memory stream to write the serialized token into
            // Use an initial size of 64Kb
            MemoryStream s = new MemoryStream(UInt16.MaxValue);

            // Create an XmlWriter over the stream
            XmlWriter xw = 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
            XmlDocument dom = new XmlDocument();
            dom.Load(s);

            // Create a KeyIdentifierClause for the SamlSecurityToken
            SamlAssertionKeyIdentifierClause samlKeyIdentifierClause = samlToken.CreateKeyIdentifierClause<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, null);
        }
    }
}

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


    '/ <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
End Class

Comentários

Use a SecurityTokenProvider classe quando forem necessários tokens de segurança personalizados. A função de um provedor de token de segurança é obter um token de segurança quando uma mensagem SOAP é enviada por um cliente e um token de segurança é usado para autenticar o cliente ou para proteger a mensagem SOAP. Especificamente, o GetToken método é chamado para obter um token de segurança. O provedor de token de segurança também pode ser chamado para cancelar e renovar uma segurança usando os CancelToken métodos e RenewToken .

Classes que derivam da SecurityTokenManager classe implementam o CreateSecurityTokenProvider método para determinar qual provedor de token de segurança é necessário para um determinado token de segurança.

As ClientCredentialsSecurityTokenManager classes e ServiceCredentialsSecurityTokenManager fornecem as implementações padrão para tipos de token de segurança internos. Para cenários de token de segurança personalizados, você deve derivar uma classe de uma das SecurityTokenManagerclasses , ClientCredentialsSecurityTokenManagerou ServiceCredentialsSecurityTokenManager e fornecer a funcionalidade para criar o provedor de token de segurança, o autenticador de token de segurança e o serializador de token de segurança para o token de segurança personalizado. Para obter mais informações sobre como criar um token personalizado, consulte Como criar um token personalizado.

Construtores

SecurityTokenProvider()

Inicializa uma nova instância da classe SecurityTokenProvider.

Propriedades

SupportsTokenCancellation	Obtém um valor que indica se o token de segurança pode ser cancelado.
SupportsTokenRenewal	Obtém um valor que indica se o token de segurança é renovável.

Métodos

BeginCancelToken(TimeSpan, SecurityToken, AsyncCallback, Object)	Inicia uma operação assíncrona para cancelar um token de segurança.
BeginCancelTokenCore(TimeSpan, SecurityToken, AsyncCallback, Object)	Inicia uma operação assíncrona para cancelar um token de segurança.
BeginGetToken(TimeSpan, AsyncCallback, Object)	Inicia uma operação assíncrona para obter um token de segurança.
BeginGetTokenCore(TimeSpan, AsyncCallback, Object)	Inicia uma operação assíncrona para obter um token de segurança.
BeginRenewToken(TimeSpan, SecurityToken, AsyncCallback, Object)	Inicia uma operação assíncrona que renova um token de segurança.
BeginRenewTokenCore(TimeSpan, SecurityToken, AsyncCallback, Object)	Inicia uma operação assíncrona que renova um token de segurança.
CancelToken(TimeSpan, SecurityToken)	Cancela um token de segurança.
CancelTokenAsync(TimeSpan, SecurityToken)	Cancela um token de segurança.
CancelTokenCore(TimeSpan, SecurityToken)	Cancela um token de segurança.
CancelTokenCoreAsync(TimeSpan, SecurityToken)	Cancela um token de segurança.
EndCancelToken(IAsyncResult)	Conclui uma operação assíncrona para cancelar um token de segurança.
EndCancelTokenCore(IAsyncResult)	Conclui uma operação assíncrona para cancelar um token de segurança.
EndGetToken(IAsyncResult)	Conclui uma operação assíncrona para obter um token de segurança.
EndGetTokenCore(IAsyncResult)	Conclui uma operação assíncrona para obter um token de segurança.
EndRenewToken(IAsyncResult)	Conclui uma operação assíncrona para renovar um token de segurança.
EndRenewTokenCore(IAsyncResult)	Conclui uma operação assíncrona para renovar o token de segurança.
Equals(Object)	Determina se o objeto especificado é igual ao objeto atual. (Herdado de Object)
GetHashCode()	Serve como a função de hash padrão. (Herdado de Object)
GetToken(TimeSpan)	Obtém um token de segurança.
GetTokenAsync(TimeSpan)	Obtém um token de segurança.
GetTokenCore(TimeSpan)	Obtém um token de segurança.
GetTokenCoreAsync(TimeSpan)	Obtém um token de segurança.
GetType()	Obtém o Type da instância atual. (Herdado de Object)
MemberwiseClone()	Cria uma cópia superficial do Object atual. (Herdado de Object)
RenewToken(TimeSpan, SecurityToken)	Renova um token de segurança.
RenewTokenAsync(TimeSpan, SecurityToken)	Renova um token de segurança.
RenewTokenCore(TimeSpan, SecurityToken)	Renova um token de segurança.
RenewTokenCoreAsync(TimeSpan, SecurityToken)	Renova um token de segurança.
ToString()	Retorna uma cadeia de caracteres que representa o objeto atual. (Herdado de Object)

Confira também

• SecurityTokenManager
• SecurityTokenAuthenticator
• Como criar um token personalizado