SecurityTokenProvider Clase

Definición

Espacio de nombres:

System.IdentityModel.Selectors

Ensamblado:

System.ServiceModel.Primitives.dll

Paquete:

System.ServiceModel.Primitives v6.2.0

Source:

SecurityTokenProvider.cs

Representa un proveedor del token de seguridad que administra tokens de seguridad para un remitente del mensaje SOAP.

public ref class SecurityTokenProvider abstract

public abstract class SecurityTokenProvider

type SecurityTokenProvider = class

Public MustInherit Class SecurityTokenProvider

Herencia

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

Ejemplos

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

Comentarios

Utilice la clase SecurityTokenProvider cuando los tokens de seguridad personalizados son obligatorios. El rol de un proveedor del token de seguridad es obtener un token de seguridad cuando un cliente envía un mensaje SOAP y un token de seguridad se utiliza para autenticar el cliente o proteger el mensaje SOAP. Específicamente, se llama al método GetToken para obtener un token de seguridad. Se puede llamar al proveedor del token de seguridad también para cancelar y renovar una seguridad mediante CancelToken y los métodos RenewToken.

Las clases que derivan de la clase SecurityTokenManager implementan el método CreateSecurityTokenProvider para determinar qué proveedor del token de seguridad es obligatorio para un token de seguridad determinado.

Las clases ClientCredentialsSecurityTokenManager y ServiceCredentialsSecurityTokenManager proporcionan las implementaciones predeterminadas para los tipos de tokens de seguridad integrados. En el caso de escenarios del token de seguridad personalizados, debe derivar una clase de una de las clases SecurityTokenManager, ClientCredentialsSecurityTokenManager o ServiceCredentialsSecurityTokenManager y proporcionar la funcionalidad para crear el proveedor del token de seguridad, autenticador del token de seguridad y serializador del token de seguridad para el token de seguridad personalizado. Para obtener más información sobre cómo crear un token personalizado, consulte How to: Create a Custom Token.

Constructores

SecurityTokenProvider()

Inicializa una nueva instancia de la clase SecurityTokenProvider.

Propiedades

SupportsTokenCancellation	Obtiene un valor que indica si el token de seguridad puede cancelarse.
SupportsTokenRenewal	Obtiene un valor que indica si el token de seguridad es renovable.

Métodos

BeginCancelToken(TimeSpan, SecurityToken, AsyncCallback, Object)	Comienza una operación asincrónica para cancelar un token de seguridad.
BeginCancelTokenCore(TimeSpan, SecurityToken, AsyncCallback, Object)	Comienza una operación asincrónica para cancelar un token de seguridad.
BeginGetToken(TimeSpan, AsyncCallback, Object)	Comienza una operación asincrónica para obtener un token de seguridad.
BeginGetTokenCore(TimeSpan, AsyncCallback, Object)	Comienza una operación asincrónica para obtener un token de seguridad.
BeginRenewToken(TimeSpan, SecurityToken, AsyncCallback, Object)	Comienza una operación asincrónica que renueva un token de seguridad.
BeginRenewTokenCore(TimeSpan, SecurityToken, AsyncCallback, Object)	Comienza una operación asincrónica que renueva un token de seguridad.
CancelToken(TimeSpan, SecurityToken)	Cancela un token de seguridad.
CancelTokenAsync(TimeSpan, SecurityToken)	Cancela un token de seguridad.
CancelTokenCore(TimeSpan, SecurityToken)	Cancela un token de seguridad.
CancelTokenCoreAsync(TimeSpan, SecurityToken)	Cancela un token de seguridad.
EndCancelToken(IAsyncResult)	Completa una operación asincrónica para cancelar un token de seguridad.
EndCancelTokenCore(IAsyncResult)	Completa una operación asincrónica para cancelar un token de seguridad.
EndGetToken(IAsyncResult)	Completa una operación asincrónica para obtener un token de seguridad.
EndGetTokenCore(IAsyncResult)	Completa una operación asincrónica para obtener un token de seguridad.
EndRenewToken(IAsyncResult)	Completa una operación asincrónica para renovar un token de seguridad.
EndRenewTokenCore(IAsyncResult)	Completa una operación asincrónica para renovar el token de seguridad.
Equals(Object)	Determina si el objeto especificado es igual que el objeto actual. (Heredado de Object)
GetHashCode()	Sirve como la función hash predeterminada. (Heredado de Object)
GetToken(TimeSpan)	Obtiene un token de seguridad.
GetTokenAsync(TimeSpan)	Obtiene un token de seguridad.
GetTokenCore(TimeSpan)	Obtiene un token de seguridad.
GetTokenCoreAsync(TimeSpan)	Obtiene un token de seguridad.
GetType()	Obtiene el Type de la instancia actual. (Heredado de Object)
MemberwiseClone()	Crea una copia superficial del Object actual. (Heredado de Object)
RenewToken(TimeSpan, SecurityToken)	Renueva un token de seguridad.
RenewTokenAsync(TimeSpan, SecurityToken)	Renueva un token de seguridad.
RenewTokenCore(TimeSpan, SecurityToken)	Renueva un token de seguridad.
RenewTokenCoreAsync(TimeSpan, SecurityToken)	Renueva un token de seguridad.
ToString()	Devuelve una cadena que representa el objeto actual. (Heredado de Object)

Consulte también

• SecurityTokenManager
• SecurityTokenAuthenticator
• Cómo: Crear un token personalizado