SecurityTokenProvider SecurityTokenProvider SecurityTokenProvider SecurityTokenProvider Class

Definition

Stellt einen Anbieter von Sicherheitstoken dar, der Sicherheitstoken für einen SOAP-Nachrichten-Absender bereitstellt.Represents a security token provider that handles security tokens for a SOAP message sender.

public ref class SecurityTokenProvider abstract
public abstract class SecurityTokenProvider
type SecurityTokenProvider = class
Public MustInherit Class SecurityTokenProvider
Vererbung
SecurityTokenProviderSecurityTokenProviderSecurityTokenProviderSecurityTokenProvider
Abgeleitet

Beispiele

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

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

Hinweise

Verwenden Sie die SecurityTokenProvider-Klasse, wenn benutzerdefinierte Sicherheitstoken benötigt werden.Use the SecurityTokenProvider class when custom security tokens are required. Die Rolle des Anbieters von Sicherheitstoken besteht darin, ein Sicherheitstoken abzurufen, wenn eine SOAP-Nachricht vom Client gesendet wird und ein Sicherheitstoken zum Authentifizieren des Clients oder zum Schutz der SOAP-Nachricht verwendet wird.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. Insbesondere wird die GetToken-Methode aufgerufen, um ein Sicherheitstoken abzurufen.Specifically, the GetToken method is called to get a security token. Der Anbieter von Sicherheitstoken kann auch aufgerufen werden, um eine Sicherheit mit der CancelToken-Methode und der RenewToken-Methode abzubrechen oder zu erneuern.The security token provider can also be called to cancel and renew a security using the CancelToken and RenewToken methods.

Klassen, die von der SecurityTokenManager-Klasse abgeleitet werden, implementieren die CreateSecurityTokenProvider-Methode, um den für ein bestimmtes Sicherheitstoken erforderlichen Anbieter von Sicherheitstoken zu bestimmen.Classes that derive from the SecurityTokenManager class implement the CreateSecurityTokenProvider method to determine which security token provider is required for a given security token.

Die ClientCredentialsSecurityTokenManager-Klasse und die ServiceCredentialsSecurityTokenManager-Klasse stellen die Standardimplementierungen für Sicherheitstoken bereit.The ClientCredentialsSecurityTokenManager and ServiceCredentialsSecurityTokenManager classes provide the default implementations for built-in security token types. Für Szenarien mit benutzerdefinierten Sicherheitstoken muss eine Klasse von der SecurityTokenManager-Klasse, der ClientCredentialsSecurityTokenManager-Klasse oder der ServiceCredentialsSecurityTokenManager-Klasse abgeleitet und die Funktion zum Erstellen des Sicherheitstokenanbieters, des Sicherheitstokenauthentifizierers und des Sicherheitstokenserialisierers für das benutzerdefinierte Sicherheitstoken bereitgestellt werden.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. Weitere Informationen zum Erstellen eines benutzerdefinierten Tokens finden Sie unter Vorgehensweise: Erstellen eines benutzerdefinierten Tokens.For more information about creating a custom token, see How to: Create a Custom Token.

Konstruktoren

SecurityTokenProvider() SecurityTokenProvider() SecurityTokenProvider() SecurityTokenProvider()

Initialisiert eine neue Instanz der SecurityTokenProvider-Klasse.Initializes a new instance of the SecurityTokenProvider class.

Eigenschaften

SupportsTokenCancellation SupportsTokenCancellation SupportsTokenCancellation SupportsTokenCancellation

Ruft einen Wert ab, der angibt, ob das Sicherheitstoken storniert werden kann.Gets a value that indicates whether the security token can be cancelled.

SupportsTokenRenewal SupportsTokenRenewal SupportsTokenRenewal SupportsTokenRenewal

Ruft einen Wert ab, der angibt, ob das Sicherheitstoken erneuerbar ist.Gets a value that indicates whether the security token is renewable.

Methoden

BeginCancelToken(TimeSpan, SecurityToken, AsyncCallback, Object) BeginCancelToken(TimeSpan, SecurityToken, AsyncCallback, Object) BeginCancelToken(TimeSpan, SecurityToken, AsyncCallback, Object) BeginCancelToken(TimeSpan, SecurityToken, AsyncCallback, Object)

Startet einen asynchronen Vorgang, um ein Sicherheitstoken abzubrechen.Begins an asynchronous operation to cancel a security token.

BeginCancelTokenCore(TimeSpan, SecurityToken, AsyncCallback, Object) BeginCancelTokenCore(TimeSpan, SecurityToken, AsyncCallback, Object) BeginCancelTokenCore(TimeSpan, SecurityToken, AsyncCallback, Object) BeginCancelTokenCore(TimeSpan, SecurityToken, AsyncCallback, Object)

Startet einen asynchronen Vorgang, um ein Sicherheitstoken abzubrechen.Begins an asynchronous operation to cancel a security token.

BeginGetToken(TimeSpan, AsyncCallback, Object) BeginGetToken(TimeSpan, AsyncCallback, Object) BeginGetToken(TimeSpan, AsyncCallback, Object) BeginGetToken(TimeSpan, AsyncCallback, Object)

Startet einen asynchronen Vorgang, um ein Sicherheitstoken abzurufen.Begins an asynchronous operation to get a security token.

BeginGetTokenCore(TimeSpan, AsyncCallback, Object) BeginGetTokenCore(TimeSpan, AsyncCallback, Object) BeginGetTokenCore(TimeSpan, AsyncCallback, Object) BeginGetTokenCore(TimeSpan, AsyncCallback, Object)

Startet einen asynchronen Vorgang, um ein Sicherheitstoken abzurufen.Begins an asynchronous operation to get a security token.

BeginRenewToken(TimeSpan, SecurityToken, AsyncCallback, Object) BeginRenewToken(TimeSpan, SecurityToken, AsyncCallback, Object) BeginRenewToken(TimeSpan, SecurityToken, AsyncCallback, Object) BeginRenewToken(TimeSpan, SecurityToken, AsyncCallback, Object)

Startet einen asynchronen Vorgang, der ein Sicherheitstoken erneuert.Begins an asynchronous operation that renews a security token.

BeginRenewTokenCore(TimeSpan, SecurityToken, AsyncCallback, Object) BeginRenewTokenCore(TimeSpan, SecurityToken, AsyncCallback, Object) BeginRenewTokenCore(TimeSpan, SecurityToken, AsyncCallback, Object) BeginRenewTokenCore(TimeSpan, SecurityToken, AsyncCallback, Object)

Startet einen asynchronen Vorgang, der ein Sicherheitstoken erneuert.Begins an asynchronous operation that renews a security token.

CancelToken(TimeSpan, SecurityToken) CancelToken(TimeSpan, SecurityToken) CancelToken(TimeSpan, SecurityToken) CancelToken(TimeSpan, SecurityToken)

Bricht ein Sicherheitstoken ab.Cancels a security token.

CancelTokenCore(TimeSpan, SecurityToken) CancelTokenCore(TimeSpan, SecurityToken) CancelTokenCore(TimeSpan, SecurityToken) CancelTokenCore(TimeSpan, SecurityToken)

Bricht ein Sicherheitstoken ab.Cancels a security token.

EndCancelToken(IAsyncResult) EndCancelToken(IAsyncResult) EndCancelToken(IAsyncResult) EndCancelToken(IAsyncResult)

Schließt einen asynchronen Vorgang ab, um ein Sicherheitstoken abzubrechen.Completes an asynchronous operation to cancel a security token.

EndCancelTokenCore(IAsyncResult) EndCancelTokenCore(IAsyncResult) EndCancelTokenCore(IAsyncResult) EndCancelTokenCore(IAsyncResult)

Schließt einen asynchronen Vorgang ab, um ein Sicherheitstoken abzubrechen.Completes an asynchronous operation to cancel a security token.

EndGetToken(IAsyncResult) EndGetToken(IAsyncResult) EndGetToken(IAsyncResult) EndGetToken(IAsyncResult)

Schließt einen asynchronen Vorgang ab, um ein Sicherheitstoken abzurufen.Completes an asynchronous operation to get a security token.

EndGetTokenCore(IAsyncResult) EndGetTokenCore(IAsyncResult) EndGetTokenCore(IAsyncResult) EndGetTokenCore(IAsyncResult)

Schließt einen asynchronen Vorgang ab, um ein Sicherheitstoken abzurufen.Completes an asynchronous operation to get a security token.

EndRenewToken(IAsyncResult) EndRenewToken(IAsyncResult) EndRenewToken(IAsyncResult) EndRenewToken(IAsyncResult)

Schließt einen asynchronen Vorgang ab, um ein Sicherheitstoken zu erneuern.Completes an asynchronous operation to renew a security token.

EndRenewTokenCore(IAsyncResult) EndRenewTokenCore(IAsyncResult) EndRenewTokenCore(IAsyncResult) EndRenewTokenCore(IAsyncResult)

Schließt einen asynchronen Vorgang ab, um das Sicherheitstoken zu erneuern.Completes an asynchronous operation to renew the security token.

Equals(Object) Equals(Object) Equals(Object) Equals(Object)

Bestimmt, ob das angegebene Objekt mit dem aktuellen Objekt identisch ist.Determines whether the specified object is equal to the current object.

(Inherited from Object)
GetHashCode() GetHashCode() GetHashCode() GetHashCode()

Fungiert als Standardhashfunktion.Serves as the default hash function.

(Inherited from Object)
GetToken(TimeSpan) GetToken(TimeSpan) GetToken(TimeSpan) GetToken(TimeSpan)

Ruft ein Sicherheitstoken ab.Gets a security token.

GetTokenCore(TimeSpan) GetTokenCore(TimeSpan) GetTokenCore(TimeSpan) GetTokenCore(TimeSpan)

Ruft ein Sicherheitstoken ab.Gets a security token.

GetType() GetType() GetType() GetType()

Ruft den Type der aktuellen Instanz ab.Gets the Type of the current instance.

(Inherited from Object)
MemberwiseClone() MemberwiseClone() MemberwiseClone() MemberwiseClone()

Erstellt eine flache Kopie des aktuellen Object.Creates a shallow copy of the current Object.

(Inherited from Object)
RenewToken(TimeSpan, SecurityToken) RenewToken(TimeSpan, SecurityToken) RenewToken(TimeSpan, SecurityToken) RenewToken(TimeSpan, SecurityToken)

Erneuert ein Sicherheitstoken.Renews a security token.

RenewTokenCore(TimeSpan, SecurityToken) RenewTokenCore(TimeSpan, SecurityToken) RenewTokenCore(TimeSpan, SecurityToken) RenewTokenCore(TimeSpan, SecurityToken)

Erneuert ein Sicherheitstoken.Renews a security token.

ToString() ToString() ToString() ToString()

Gibt eine Zeichenfolge zurück, die das aktuelle Objekt darstellt.Returns a string that represents the current object.

(Inherited from Object)

Gilt für:

Siehe auch