SecurityTokenHandler 类

定义

public ref class SecurityTokenHandler abstract : System::IdentityModel::Configuration::ICustomIdentityConfiguration

public abstract class SecurityTokenHandler : System.IdentityModel.Configuration.ICustomIdentityConfiguration

type SecurityTokenHandler = class
    interface ICustomIdentityConfiguration

Public MustInherit Class SecurityTokenHandler
Implements ICustomIdentityConfiguration

继承

Object

SecurityTokenHandler

派生

System.IdentityModel.Tokens.EncryptedSecurityTokenHandler

System.IdentityModel.Tokens.KerberosSecurityTokenHandler

System.IdentityModel.Tokens.RsaSecurityTokenHandler

System.IdentityModel.Tokens.Saml2SecurityTokenHandler

System.IdentityModel.Tokens.SamlSecurityTokenHandler

更多…

实现

ICustomIdentityConfiguration

示例

所有 SecurityTokenHandler 主题中的代码示例均摘自 Custom Token 示例。 此示例提供自定义类，这些类支持 (SWT) 处理简单 Web 令牌。 有关此示例和其他可用于 WIF 的示例以及下载位置的信息，请参阅 WIF 代码示例索引。 以下 XML 演示如何将 SWT 标记处理程序添加到令牌处理程序集合。

<system.identityModel>
  <identityConfiguration saveBootstrapContext="true">
    <issuerTokenResolver type="SimpleWebToken.CustomIssuerTokenResolver, SimpleWebToken">
      <AddAudienceKeyPair  symmetricKey="wAVkldQiFypTQ+kdNdGWCYCHRcee8XmXxOvgmak8vSY=" audience="http://localhost:19851/" />
    </issuerTokenResolver>
    <issuerNameRegistry type="RelyingParty.TrustedIssuerNameRegistry, RelyingParty"/>
    <audienceUris>
      <add value="http://localhost:19851/"/>
    </audienceUris>
    <securityTokenHandlers>
      <add type="SimpleWebToken.SimpleWebTokenHandler, SimpleWebToken" />
    </securityTokenHandlers>
  </identityConfiguration>
</system.identityModel>

注解

类 SecurityTokenHandler 是所有安全令牌处理程序从中派生的基类。 安全令牌处理程序负责：

• 验证安全令牌 (SecurityToken 设计用于处理令牌中包含的声明并将其打包到 ClaimsIdentity 对象中的类型) 。

• 序列化和反序列化其设计要处理的安全令牌类型。

• 序列化和反序列化密钥标识符子句 (SecurityKeyIdentifierClause) ，这些子句引用其设计用于处理的类型的标记，并将其与元素进行 <wsse:SecurityTokenReference> 反序列化。

• 从 SecurityTokenDescriptor 类的实现传递的对象 SecurityTokenService 创建安全令牌。

• 从安全令牌为 类的 SecurityTokenService 实现创建密钥标识符子句。

Windows Identity Foundation (WIF) 提供以下现成的安全令牌处理程序：

• EncryptedSecurityTokenHandler

• KerberosSecurityTokenHandler

• MachineKeySessionSecurityTokenHandler

• MembershipUserNameSecurityTokenHandler

• RsaSecurityTokenHandler

• Saml2SecurityTokenHandler

• SamlSecurityTokenHandler

• SessionSecurityTokenHandler

• UserNameSecurityTokenHandler

• WindowsUserNameSecurityTokenHandler

• X509SecurityTokenHandler

这些类中的大多数都公开了实现特定于处理其类的标记的功能的其他成员。 在许多情况下，最好是从其中一个类派生，而不是直接从 SecurityTokenHandler 类派生。

通过在配置文件的 securityTokenHandlers> 元素下<指定 <add>、<remove> 或 <clear> 元素，可以在令牌处理程序集合中添加或删除安全令牌处理程序。 SecurityTokenHandlerConfiguration可以通过 属性访问包含处理程序集合配置设置的 对象，也可以从 ConfigurationContainingCollection 属性访问令牌处理程序所属的处理程序集合。 可以重写 方法以 LoadCustomConfiguration 处理处理程序采用的任何自定义配置元素。

类 SecurityTokenHandler 公开了其他几个属性和方法。 根据选择实现的功能，可以替代其中部分或全部成员。

必须重写 TokenType 属性和 方法， GetTokenTypeIdentifiers 以便向 WIF 基础结构提供有关类旨在处理的安全令牌类型的信息。

验证、序列化和反序列化功能通过属性或方法公开，这些属性或方法指示处理程序是否可以执行与实现该功能的方法结合使用的特定函数。 以下列表将指示功能的属性或方法与实现该功能的方法配对：

• 属性 CanValidateToken 和 ValidateToken 方法：验证令牌并将令牌中包含的声明打包到 中 ClaimsIdentity。

• 属性 CanWriteToken 和 WriteToken 方法：令牌序列化。

• CanReadToken方法和ReadToken方法：令牌反序列化。

• CanReadKeyIdentifierClause方法和 ReadKeyIdentifierClause 方法：反序列化密钥标识符子句。

• CanWriteKeyIdentifierClause方法和 WriteKeyIdentifierClause 方法：序列化密钥标识符子句。

CreateToken和 CreateSecurityTokenReference 方法在 类的SecurityTokenService实现中从管道中调用。

DetectReplayedToken方法由 WIF 基础结构调用，以确定是否已收到指定的令牌。 默认情况下，此方法返回 false，指示尚未收到令牌。 可以重写 方法并提供逻辑来检测重播的令牌。

构造函数

属性

方法

适用于

另请参阅

• SecurityToken
• SecurityKeyIdentifier
• SecurityTokenService