SecurityTokenProvider Klasse

Definition

Namespace:

System.IdentityModel.Selectors

Assembly:

System.ServiceModel.Primitives.dll

Paket:

System.ServiceModel.Primitives v6.2.0

Quelle:

SecurityTokenProvider.cs

Stellt einen Anbieter von Sicherheitstoken dar, der Sicherheitstoken für einen SOAP-Nachrichten-Absender bereitstellt.

public ref class SecurityTokenProvider abstract

public abstract class SecurityTokenProvider

type SecurityTokenProvider = class

Public MustInherit Class SecurityTokenProvider

Vererbung

Object

SecurityTokenProvider

Abgeleitet

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

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.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

Hinweise

Verwenden Sie die SecurityTokenProvider-Klasse, wenn benutzerdefinierte Sicherheitstoken benötigt werden. 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. Insbesondere wird die GetToken-Methode aufgerufen, um ein Sicherheitstoken abzurufen. Der Anbieter von Sicherheitstoken kann auch aufgerufen werden, um eine Sicherheit mit der CancelToken-Methode und der RenewToken-Methode abzubrechen oder zu erneuern.

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.

Die ClientCredentialsSecurityTokenManager-Klasse und die ServiceCredentialsSecurityTokenManager-Klasse stellen die Standardimplementierungen für Sicherheitstoken bereit. 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. Weitere Informationen zum Erstellen eines benutzerdefinierten Tokens finden Sie unter Vorgehensweise: Erstellen eines benutzerdefinierten Tokens.

Konstruktoren

SecurityTokenProvider()

Initialisiert eine neue Instanz der SecurityTokenProvider-Klasse.

Eigenschaften

SupportsTokenCancellation	Ruft einen Wert ab, der angibt, ob das Sicherheitstoken storniert werden kann.
SupportsTokenRenewal	Ruft einen Wert ab, der angibt, ob das Sicherheitstoken erneuerbar ist.

Methoden

BeginCancelToken(TimeSpan, SecurityToken, AsyncCallback, Object)	Startet einen asynchronen Vorgang, um ein Sicherheitstoken abzubrechen.
BeginCancelTokenCore(TimeSpan, SecurityToken, AsyncCallback, Object)	Startet einen asynchronen Vorgang, um ein Sicherheitstoken abzubrechen.
BeginGetToken(TimeSpan, AsyncCallback, Object)	Startet einen asynchronen Vorgang, um ein Sicherheitstoken abzurufen.
BeginGetTokenCore(TimeSpan, AsyncCallback, Object)	Startet einen asynchronen Vorgang, um ein Sicherheitstoken abzurufen.
BeginRenewToken(TimeSpan, SecurityToken, AsyncCallback, Object)	Startet einen asynchronen Vorgang, der ein Sicherheitstoken erneuert.
BeginRenewTokenCore(TimeSpan, SecurityToken, AsyncCallback, Object)	Startet einen asynchronen Vorgang, der ein Sicherheitstoken erneuert.
CancelToken(TimeSpan, SecurityToken)	Bricht ein Sicherheitstoken ab.
CancelTokenAsync(TimeSpan, SecurityToken)	Bricht ein Sicherheitstoken ab.
CancelTokenCore(TimeSpan, SecurityToken)	Bricht ein Sicherheitstoken ab.
CancelTokenCoreAsync(TimeSpan, SecurityToken)	Bricht ein Sicherheitstoken ab.
EndCancelToken(IAsyncResult)	Schließt einen asynchronen Vorgang ab, um ein Sicherheitstoken abzubrechen.
EndCancelTokenCore(IAsyncResult)	Schließt einen asynchronen Vorgang ab, um ein Sicherheitstoken abzubrechen.
EndGetToken(IAsyncResult)	Schließt einen asynchronen Vorgang ab, um ein Sicherheitstoken abzurufen.
EndGetTokenCore(IAsyncResult)	Schließt einen asynchronen Vorgang ab, um ein Sicherheitstoken abzurufen.
EndRenewToken(IAsyncResult)	Schließt einen asynchronen Vorgang ab, um ein Sicherheitstoken zu erneuern.
EndRenewTokenCore(IAsyncResult)	Schließt einen asynchronen Vorgang ab, um das Sicherheitstoken zu erneuern.
Equals(Object)	Bestimmt, ob das angegebene Objekt gleich dem aktuellen Objekt ist. (Geerbt von Object)
GetHashCode()	Fungiert als Standardhashfunktion. (Geerbt von Object)
GetToken(TimeSpan)	Ruft ein Sicherheitstoken ab.
GetTokenAsync(TimeSpan)	Ruft ein Sicherheitstoken ab.
GetTokenCore(TimeSpan)	Ruft ein Sicherheitstoken ab.
GetTokenCoreAsync(TimeSpan)	Ruft ein Sicherheitstoken ab.
GetType()	Ruft den Type der aktuellen Instanz ab. (Geerbt von Object)
MemberwiseClone()	Erstellt eine flache Kopie des aktuellen Object. (Geerbt von Object)
RenewToken(TimeSpan, SecurityToken)	Erneuert ein Sicherheitstoken.
RenewTokenAsync(TimeSpan, SecurityToken)	Erneuert ein Sicherheitstoken.
RenewTokenCore(TimeSpan, SecurityToken)	Erneuert ein Sicherheitstoken.
RenewTokenCoreAsync(TimeSpan, SecurityToken)	Erneuert ein Sicherheitstoken.
ToString()	Gibt eine Zeichenfolge zurück, die das aktuelle Objekt darstellt. (Geerbt von Object)

Weitere Informationen

• SecurityTokenManager
• SecurityTokenAuthenticator
• Vorgehensweise: Erstellen eines benutzerdefinierten Tokens