SecurityToken 類別

定義

public ref class SecurityToken abstract

public abstract class SecurityToken

type SecurityToken = class

Public MustInherit Class SecurityToken

繼承

Object

SecurityToken

衍生

System.IdentityModel.Tokens.EncryptedSecurityToken

System.IdentityModel.Tokens.GenericXmlSecurityToken

System.IdentityModel.Tokens.KerberosRequestorSecurityToken

System.IdentityModel.Tokens.RsaSecurityToken

System.IdentityModel.Tokens.Saml2SecurityToken

更多…

範例

主題中使用的 SecurityToken 程式碼範例取自 Custom Token 範例。 此範例提供自訂類別，可讓您處理簡單的 Web 權杖 (SWT) 。 它包含類別和 SimpleWebTokenHandler 類別的 SimpleWebToken 實作，以及支援 SWT 權杖的其他類別。 如需適用于 WIF 的這個範例和其他範例的相關資訊，以及下載這些範例的位置，請參閱 WIF 程式碼範例索引。 下列程式碼顯示 類別的實作 SimpleWebToken 。 這個類別會 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 );
        } 
    }    
}

備註

使用安全性權杖，提供驗證認證或保護訊息。

安全性權杖可用來提供驗證認證、密碼編譯金鑰資料，或在安全性權杖服務所簽發的安全性權杖的情況下， (STS) ，這是關於主體的宣告集合。 所有安全性權杖都衍生自 SecurityToken 類別。

從 .NET 4.5 開始，Windows Identity Foundation (WIF) 已完全整合到.NET Framework，而 WIF 公開的類別是處理常式代碼中安全性權杖的慣用方法。 在 WIF 中，安全性權杖會序列化和還原序列化至其 XML 表示，並使用衍生自基類的 SecurityTokenHandler 類別進行驗證。 驗證權杖不僅牽涉到確保權杖有效，也會從權杖傳回 ClaimsIdentity 實例，以便進行驗證和授權決策。 是由 ClaimsIdentity 權杖處理常式的 方法實 ValidateToken 作所建構，其來自權杖中包含的宣告，以及來自權杖類型本身內建的宣告。

WIF 隨附下列安全性權杖類型的支援：

• Saml2SecurityToken：表示以 SAML 2.0 判斷提示為基礎的安全性權杖。 此權杖類型通常是由安全性權杖服務發出，以回應 RST) WS-Trust或WS-Federation安全性權杖 (要求。

• SamlSecurityToken：表示以 SAML 1.1 判斷提示為基礎的安全性權杖。 此權杖類型通常是由安全性權杖服務發出，以回應 RST) WS-Trust或WS-Federation安全性權杖 (要求。

• KerberosRequestorSecurityToken 和 KerberosReceiverSecurityToken ：代表以 SOAP 訊息中接收或傳送之 Kerberos 票證為基礎的安全性權杖

• RsaSecurityToken：表示以使用 RSA 演算法所建立之金鑰為基礎的安全性權杖。

• SessionSecurityToken：表示包含會話相關資訊的安全性權杖。

• UserNameSecurityToken：表示以使用者名稱和密碼為基礎的安全性權杖。

• WindowsSecurityToken：代表以 Windows 網域或使用者帳戶身分識別為基礎的安全性權杖。

• X509SecurityToken：表示以 X.509 憑證為基礎的安全性權杖。

• X509WindowsSecurityToken：表示以對應至 Windows 網域使用者或本機電腦使用者帳戶之 X.509 憑證為基礎的安全性權杖。

另外兩個安全性權杖類別 GenericXmlSecurityToken 和 EncryptedSecurityToken ，可用來協助處理一般案例。

廣泛來說，安全性權杖分為三個主要類別：

• 包含或參考密碼編譯金鑰資料的權杖。 例如， RsaSecurityToken 和 X509SecurityToken 型別通常用於此用途。

• 權杖，代表已驗證之使用者的認證。 例如， UserNameSecurityToken 、 WindowsSecurityToken 和 ，如果是使用憑證驗證的使用者，則 X509SecurityToken 為 類型。

• 安全性權杖服務所簽發的權杖 (STS) ，以使用 WS-Trust 或 WS-Federation 通訊協定回應安全性權杖要求。 這些通常會在 XML 片段中 wst:RequestSecurityTokenResponse 傳回。 Saml2SecurityToken和 SamlSecurityToken 類型最常用來表示這些權杖。

特殊權杖類型 ， SessionSecurityToken 包含在使用主動或被動案例中使用會話時，重新建立主體所需的資訊。

若要將功能新增至現有的權杖類型，您可以衍生自特定類型和其相關聯的權杖處理常式，以支援您新增至權杖的任何新元素。 若要新增對新權杖類型的支援，您可以直接從 SecurityToken 類別衍生。 當您這樣做時，也需要從 SecurityTokenHandler 類別衍生來建立權杖處理常式類別。 根據權杖的使用方式，您可能也需要藉由衍生自 IssuerTokenResolver 類別，以及衍生自 SecurityKeyIdentifierClause 類別的一或多個自訂金鑰識別碼子句類型，來建立自訂權杖解析程式。

給實施者的注意事項

您必須覆寫 Id 、 SecurityKeys 、 ValidFrom 和 ValidTo 屬性。 CanCreateKeyIdentifierClause<T>()、 CreateKeyIdentifierClause<T>() 、 MatchesKeyIdentifierClause(SecurityKeyIdentifierClause) 和 ResolveKeyIdentifierClause(SecurityKeyIdentifierClause) 方法全都支援 類型的 LocalIdKeyIdentifierClause 金鑰識別碼。 您必須覆寫這些方法，以支援衍生類別中的其他金鑰識別碼類型。

建構函式

屬性

方法

適用於

另請參閱

• SecurityTokenHandler
• SecurityKeyIdentifierClause
• IssuerTokenResolver
• LocalIdKeyIdentifierClause