SecurityToken Klasse

Definition

Stellt eine Basisklasse dar, die verwendet wird, um alle Sicherheitstoken zu implementieren.Represents a base class used to implement all security tokens.

public ref class SecurityToken abstract
public abstract class SecurityToken
type SecurityToken = class
Public MustInherit Class SecurityToken
Vererbung
SecurityToken
Abgeleitet

Beispiele

Die in den Themen verwendeten Codebeispiele stammen SecurityToken aus dem Custom Token Beispiel.The code examples that are used in the SecurityToken topics are taken from the Custom Token sample. Dieses Beispiel stellt benutzerdefinierte Klassen bereit, die die Verarbeitung von Simple Web Tokens (Swap) ermöglichen.This sample provides custom classes that enable processing of Simple Web Tokens (SWT). Sie enthält eine Implementierung einer SimpleWebToken -Klasse und einer- SimpleWebTokenHandler Klasse sowie andere Klassen, die Swap-Token unterstützen.It includes an implementation of a SimpleWebToken class and a SimpleWebTokenHandler class, as well as other classes that support SWT tokens. Informationen zu diesem Beispiel und anderen Beispielen, die für WIF verfügbar sind, und Informationen dazu, wo Sie heruntergeladen werden, finden Sie unter Beispiel Index für WIF-CodeFor information about this sample and other samples available for WIF and about where to download them, see WIF Code Sample Index. Der folgende Code zeigt die Implementierung der- SimpleWebToken Klasse.The following code shows the implementation of the SimpleWebToken class. Diese Klasse erweitert SecurityToken .This class extends SecurityToken.

/// <summary>
/// Defines the set of constants for the Simple Web Token.
/// </summary>
public static class SimpleWebTokenConstants
{
    public const string Audience = "Audience";
    public const string ExpiresOn = "ExpiresOn";
    public const string Id = "Id";
    public const string Issuer = "Issuer";
    public const string Signature = "HMACSHA256";
    public const string ValidFrom = "ValidFrom";
    public const string ValueTypeUri = "http://schemas.xmlsoap.org/ws/2009/11/swt-token-profile-1.0";     
}
using System;
using System.Collections.Generic;
using System.Collections.ObjectModel;
using System.Collections.Specialized;
using System.IdentityModel.Tokens;

namespace SimpleWebToken
{
    /// <summary>
    /// This class represents the token format for the SimpleWebToken.
    /// </summary>
    public class SimpleWebToken : SecurityToken
    {
        public static DateTime SwtBaseTime = new DateTime( 1970, 1, 1, 0, 0, 0, 0 ); // per SWT psec

        NameValueCollection _properties;
        string _serializedToken;

        /// <summary>
        /// Initializes a new instance of the <see cref="SimpleWebToken"/> class.
        /// This is an internal constructor that is only called from the <see cref="SimpleWebTokenHandler"/> when reading a token received from the wire.
        /// </summary>
        /// <param name="properties">The collection representing all the key value pairs in the token.</param>
        /// <param name="serializedToken">The serialized form of the token.</param>
        internal SimpleWebToken( NameValueCollection properties, string serializedToken )
            : this(properties)
        {
            _serializedToken = serializedToken;
        }

        /// <summary>
        /// Initializes a new instance of the <see cref="SimpleWebToken"/> class.
        /// </summary>
        /// <param name="properties">The collection representing all the key value pairs in the token.</param>
        public SimpleWebToken( NameValueCollection properties )
        {
            if ( properties == null )
            {
                throw new ArgumentNullException( "properties" );
            }

            _properties = properties;
        }

        /// <summary>
        /// Gets the Id of the token.
        /// </summary>
        /// <value>The Id of the token.</value>
        public override string Id
        {
            get 
            {
                return _properties[SimpleWebTokenConstants.Id];
            }
        }

        /// <summary>
        /// Gets the keys associated with this token.
        /// </summary>
        /// <value>The keys associated with this token.</value>
        public override ReadOnlyCollection<SecurityKey> SecurityKeys
        {
            get 
            { 
                return new ReadOnlyCollection<SecurityKey>( new List<SecurityKey>() ); 
            }
        }

        /// <summary>
        /// Gets the time from when the token is valid.
        /// </summary>
        /// <value>The time from when the token is valid.</value>
        public override DateTime ValidFrom
        {
            get 
            {
                string validFrom = _properties[SimpleWebTokenConstants.ValidFrom];
                return GetTimeAsDateTime( String.IsNullOrEmpty( validFrom ) ? "0" : validFrom );
            }
        }

        /// <summary>
        /// Gets the time when the token expires.
        /// </summary>
        /// <value>The time up to which the token is valid.</value>
        public override DateTime ValidTo
        {
            get
            {
                string expiryTime = _properties[SimpleWebTokenConstants.ExpiresOn];
                return GetTimeAsDateTime( String.IsNullOrEmpty( expiryTime ) ? "0" : expiryTime );
            }
        }

        /// <summary>
        /// Gets the Audience for the token.
        /// </summary>
        /// <value>The audience of the token.</value>
        public string Audience
        {
            get 
            {
                return _properties[SimpleWebTokenConstants.Audience];
            }
        }

        /// <summary>
        /// Gets the Issuer for the token.
        /// </summary>
        /// <value>The issuer for the token.</value>
        public string Issuer
        {
            get 
            { 
                return _properties[SimpleWebTokenConstants.Issuer]; 
            }
        }

        /// <summary>
        /// Gets the signature for the token.
        /// </summary>
        /// <value>The signature for the token.</value>
        public string Signature
        {
            get 
            { 
                return _properties[SimpleWebTokenConstants.Signature]; 
            }
        }

        /// <summary>
        /// Gets the serialized form of the token if the token was created from its serialized form by the token handler.
        /// </summary>
        /// <value>The serialized form of the token.</value>
        public string SerializedToken
        {
            get
            {
                return _serializedToken;
            }
        }

        /// <summary>
        /// Creates a copy of all key value pairs of the token.
        /// </summary>
        /// <returns>A copy of all the key value pairs in the token.</returns>
        public NameValueCollection GetAllProperties()
        {
            return new NameValueCollection( _properties );
        }

        /// <summary>
        /// Converts the time in seconds to a <see cref="DateTime"/> object based on the base time 
        /// defined by the Simple Web Token.
        /// </summary>
        /// <param name="expiryTime">The time in seconds.</param>
        /// <returns>The time as a <see cref="DateTime"/> object.</returns>
        protected virtual DateTime GetTimeAsDateTime( string expiryTime )
        {
            long totalSeconds = 0;
            if ( !long.TryParse( expiryTime, out totalSeconds ) )
            {
                throw new SecurityTokenException("Invalid expiry time. Expected the time to be in seconds passed from 1 January 1970.");
            }

            long maxSeconds = (long)( DateTime.MaxValue - SwtBaseTime ).TotalSeconds - 1;
            if ( totalSeconds > maxSeconds )
            {
                totalSeconds = maxSeconds;
            }

            return SwtBaseTime.AddSeconds( totalSeconds );
        } 
    }    
}

Hinweise

Verwenden Sie ein Sicherheitstoken, um Authentifizierungsinformationen bereitzustellen oder eine Meldung zu schützen.Use a security token to provide authentication credentials or to protect a message.

Ein Sicherheits Token kann verwendet werden, um Authentifizierungs Anmelde Informationen, kryptografieschlüsselmaterial oder im Falle eines von einem Sicherheitstokendienst (Security Token Service, STS) ausgestellten Sicherheits Tokens, eine Sammlung von Ansprüchen zu einem Betreff, bereitzustellen.A security token can be used to provide authentication credentials, cryptographic key material, or, in the case of a security token issued by a security token service (STS), a collection of claims about a subject. Alle Sicherheits Token werden von der- SecurityToken Klasse abgeleitet.All security tokens derive from the SecurityToken class.

Ab .NET 4,5 ist Windows Identity Foundation (WIF) vollständig in den .NET Framework integriert, und die von WIF bereitgestellten Klassen sind die bevorzugte Methode für die Behandlung von Sicherheits Token in Ihrem Code.Beginning with .NET 4.5, Windows Identity Foundation (WIF) has been fully integrated into the .NET Framework and the classes exposed by WIF are the preferred method of handling security tokens in your code. In WIF werden Sicherheits Token in und aus Ihrer XML-Darstellung serialisiert und deserialisiert und mithilfe von Klassen überprüft, die von der- SecurityTokenHandler Basisklasse abgeleitet werden.In WIF, security tokens are serialized and deserialized to and from their XML representation and are validated by using classes derived from the SecurityTokenHandler base class. Wenn Sie ein Token überprüfen, müssen Sie nicht nur sicherstellen, dass das Token gültig ist, sondern auch eine- ClaimsIdentity Instanz aus dem Token zurückgeben, die für Authentifizierungs-und Autorisierungs Entscheidungen verwendet werden kann.Validating a token involves not just ensuring that the token is valid, but also returning a ClaimsIdentity instance from the token that can be used in making authentication and authorization decisions. Der ClaimsIdentity wird von der-Methode des tokenhandlers der- ValidateToken Methode aus den Ansprüchen im Token und von Ansprüchen erstellt, die für den Tokentyp selbst intrinsisch sind.The ClaimsIdentity is constructed by the token handler's implementation of the ValidateToken method from the claims contained in the token as well as from claims that are intrinsic to the token type itself.

WIF bietet Unterstützung für die folgenden Arten von Sicherheits Token:WIF ships with support for the following types of security tokens:

  • Saml2SecurityToken: Stellt ein Sicherheits Token dar, das auf einer SAML 2,0-Assertion basiert.Saml2SecurityToken: Represents a security token that is based upon a SAML 2.0 Assertion. Dieser Tokentyp wird in der Regel von einem Sicherheitstokendienst als Antwort auf eine WS-Trust-oder WS-Verbund-Sicherheitstokenanforderung (RST) ausgegeben.This token type is typically issued by a security token service in response to a WS-Trust or WS-Federation security token request (RST).

  • SamlSecurityToken: Stellt ein Sicherheits Token dar, das auf einer SAML 1,1-Assertion basiert.SamlSecurityToken: Represents a security token that is based upon a SAML 1.1 Assertion. Dieser Tokentyp wird in der Regel von einem Sicherheitstokendienst als Antwort auf eine WS-Trust-oder WS-Verbund-Sicherheitstokenanforderung (RST) ausgegeben.This token type is typically issued by a security token service in response to a WS-Trust or WS-Federation security token request (RST).

  • KerberosRequestorSecurityToken und KerberosReceiverSecurityToken : stellt ein Sicherheits Token dar, das auf einem Kerberos-Ticket basiert, das in einer SOAP-Nachricht empfangen oder gesendet wird.KerberosRequestorSecurityToken and KerberosReceiverSecurityToken: Represents a security token that is based upon a Kerberos ticket that is received or sent in a SOAP message

  • RsaSecurityToken: Stellt ein Sicherheits Token dar, das auf einem Schlüssel basiert, der mit dem RSA-Algorithmus erstellt wird.RsaSecurityToken: Represents a security token that is based upon key that is created using the RSA algorithm.

  • SessionSecurityToken: Stellt ein Sicherheits Token dar, das Informationen über eine Sitzung enthält.SessionSecurityToken: Represents a security token that contains information about a session.

  • UserNameSecurityToken: Stellt ein Sicherheits Token dar, das auf einem Benutzernamen und einem Kennwort basiert.UserNameSecurityToken: Represents a security token that is based on a username and password.

  • WindowsSecurityToken: Stellt ein Sicherheits Token dar, das auf der Identität einer Windows-Domäne oder eines Benutzerkontos basiert.WindowsSecurityToken: Represents a security token that is based on the identity of a Windows domain or user account.

  • X509SecurityToken: Stellt ein Sicherheits Token dar, das auf einem X. 509-Zertifikat basiert.X509SecurityToken: Represents a security token that is based on an X.509 certificate.

  • X509WindowsSecurityToken: Stellt ein Sicherheits Token dar, das auf einem X. 509-Zertifikat basiert, das einem Windows-Domänen Benutzerkonto oder einem lokalen Benutzerkonto zugeordnet ist.X509WindowsSecurityToken: Represents a security token that is based upon an X.509 certificate that is mapped to a Windows domain user or local computer user account.

Zwei weitere sicherheitstokenklassen GenericXmlSecurityToken und EncryptedSecurityToken können verwendet werden, um allgemeine Fälle zu behandeln.Two other security token classes, GenericXmlSecurityToken and EncryptedSecurityToken, can be used to help handle general cases.

Groß sprachige Sicherheits Token werden in drei Hauptkategorien unterteilt:Broadly speaking security tokens fall into three major categories:

  • Token, die kryptografieschlüsselmaterial enthalten oder referenzieren.Tokens that carry or reference cryptographic key material. Beispielsweise RsaSecurityToken werden die X509SecurityToken Typen und häufig zu diesem Zweck verwendet.For example the RsaSecurityToken and X509SecurityToken types are often used for this purpose.

  • Token, die Anmelde Informationen für Benutzer darstellen, die bereits authentifiziert wurden.Tokens that represent credentials for users that have already been authenticated. Beispielsweise werden, UserNameSecurityToken WindowsSecurityToken und bei einem Benutzer, der mit einem Zertifikat authentifiziert wurde, die X509SecurityToken Typen.For example, the UserNameSecurityToken, WindowsSecurityToken, and, in the case of a user authenticated using a certificate, the X509SecurityToken types.

  • Token, die von einem Sicherheitstokendienst (STS) als Antwort auf eine Sicherheitstokenanforderung ausgegeben werden, entweder mithilfe des WS-Trust-oder WS-Federation-Protokolls.Tokens that are issued by a security token service (STS) in response to a security token request using either the WS-Trust or WS-Federation protocol. Diese werden in der Regel in einem XML-Fragment zurückgegeben wst:RequestSecurityTokenResponse .These are typically returned in a wst:RequestSecurityTokenResponse XML fragment. Der Saml2SecurityToken -Typ und der- SamlSecurityToken Typ werden am häufigsten zur Darstellung dieser Token verwendet.The Saml2SecurityToken and SamlSecurityToken types are most often used to represent these tokens.

Ein spezieller Tokentyp, der SessionSecurityToken enthält Informationen, die erforderlich sind, um einen Prinzipal bei der Verwendung von Sitzungen in aktiven oder passiven Szenarien neu zu erstellen.A special token type, the SessionSecurityToken, contains information necessary to recreate a principal when using sessions in active or passive scenarios.

Zum Hinzufügen von Funktionalität zu vorhandenen Tokentypen können Sie vom jeweiligen Typ und dem zugehörigen Tokenhandler ableiten, um alle neuen Elemente zu unterstützen, die Sie dem Token hinzufügen.To add functionality to existing token types you can derive from the specific type and its associated token handler to support any new elements that you add to the token. Um Unterstützung für neue Tokentypen hinzuzufügen, können Sie diese direkt von der- SecurityToken Klasse ableiten.To add support for new token types, you can derive directly from the SecurityToken class. Wenn Sie dies tun, müssen Sie auch eine tokenhandlerklasse erstellen, indem Sie von der- SecurityTokenHandler Klasse ableiten.When you do this, you will also need to create a token handler class by deriving from the SecurityTokenHandler class. Abhängig davon, wie das Token verwendet werden soll, müssen Sie möglicherweise auch einen benutzerdefinierten tokenresolver erstellen, indem Sie von der- IssuerTokenResolver Klasse sowie von einem oder mehreren benutzerdefinierten schlüsselbezeichnerklauseltypen ableiten, indem Sie von der- SecurityKeyIdentifierClause Klasse ableiten.Depending on how your token is to be used, you may also need to create a custom token resolver by deriving from the IssuerTokenResolver class as well as one or more custom key identifier clause types by deriving from the SecurityKeyIdentifierClause class.

Hinweise für Ausführende

Sie müssen die Id Eigenschaften, SecurityKeys , ValidFrom und überschreiben ValidTo .You must override the Id, SecurityKeys, ValidFrom, and ValidTo properties. Die CanCreateKeyIdentifierClause<T>() CreateKeyIdentifierClause<T>() Methoden,, MatchesKeyIdentifierClause(SecurityKeyIdentifierClause) und ResolveKeyIdentifierClause(SecurityKeyIdentifierClause) unterstützen alle Schlüssel Bezeichner des Typs LocalIdKeyIdentifierClause .The CanCreateKeyIdentifierClause<T>(), CreateKeyIdentifierClause<T>(), MatchesKeyIdentifierClause(SecurityKeyIdentifierClause), and ResolveKeyIdentifierClause(SecurityKeyIdentifierClause) methods all support key identifiers of type LocalIdKeyIdentifierClause. Sie müssen diese Methoden überschreiben, um andere schlüsselbezeichnertypen in der abgeleiteten Klasse zu unterstützen.You must override these methods to support other key identifier types in your derived class.

Konstruktoren

SecurityToken()

Wird von Konstruktoren in abgeleiteten Klassen aufgerufen, um die SecurityToken-Klasse zu initialisieren.Called by constructors in derived classes to initialize the SecurityToken class.

Eigenschaften

Id

Ruft einen eindeutigen Bezeichner für das Sicherheitstoken ab.Gets a unique identifier of the security token.

SecurityKeys

Ruft die dem Sicherheitstoken zugeordneten kryptografischen Schlüssel ab.Gets the cryptographic keys associated with the security token.

ValidFrom

Ruft den ersten Zeitpunkt ab, zu dem dieses Sicherheitstoken gültig ist.Gets the first instant in time at which this security token is valid.

ValidTo

Ruft den spätest möglichen Zeitpunkt ab, zu dem dieses Sicherheitstoken gültig ist.Gets the last instant in time at which this security token is valid.

Methoden

CanCreateKeyIdentifierClause<T>()

Ruft einen Wert ab, der angibt, ob dieses Sicherheitstoken den angegebenen Schlüsselbezeichner erstellen kann.Gets a value that indicates whether this security token is capable of creating the specified key identifier.

CreateKeyIdentifierClause<T>()

Erstellt die angegebene Schlüsselbezeichnerklausel.Creates the specified key identifier clause.

Equals(Object)

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

(Geerbt von Object)
GetHashCode()

Fungiert als Standardhashfunktion.Serves as the default hash function.

(Geerbt von Object)
GetType()

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

(Geerbt von Object)
MatchesKeyIdentifierClause(SecurityKeyIdentifierClause)

Gibt einen Wert zurück, der angibt, ob der Schlüsselbezeichner für diese Instanz auf den angegebenen Schlüsselbezeichner aufgelöst werden kann.Returns a value that indicates whether the key identifier for this instance can be resolved to the specified key identifier.

MemberwiseClone()

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

(Geerbt von Object)
ResolveKeyIdentifierClause(SecurityKeyIdentifierClause)

Ruft den Schlüssel für die angegebene Schlüsselbezeichnerklausel ab.Gets the key for the specified key identifier clause.

ToString()

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

(Geerbt von Object)

Gilt für:

Weitere Informationen