SecurityTokenHandler Classe

Définition

Classe de base abstraite pour les gestionnaires de jetons de sécurité.The abstract base class for security token handlers.

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
Héritage
SecurityTokenHandler
Dérivé
Implémente

Exemples

Les exemples de code de toutes les SecurityTokenHandler rubriques sont tirés de l' Custom Token exemple.The code examples in all of the SecurityTokenHandler topics are taken from the Custom Token sample. Cet exemple fournit des classes personnalisées qui permettent le traitement de jetons Web simples (SWT).This sample provides custom classes that enable processing of Simple Web Tokens (SWT). Pour plus d’informations sur cet exemple et d’autres exemples disponibles pour WIF et l’emplacement de leur téléchargement, consultez exemple d’index de code WIF.For information about this sample and other samples available for WIF and where to download them, see WIF Code Sample Index. Le code XML suivant montre comment ajouter le gestionnaire de jetons SWT à la collection de gestionnaires de jetons.The following XML shows how to add the SWT token handler to the token handlers collection.

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

Remarques

La SecurityTokenHandler classe est la classe de base dont dérivent tous les gestionnaires de jetons de sécurité.The SecurityTokenHandler class is the base class from which all security token handlers derive. Un gestionnaire de jetons de sécurité est chargé des opérations suivantes :A security token handler is responsible for:

  • Validation des jetons de sécurité ( SecurityToken ) du type il est conçu pour traiter et empaqueter les revendications contenues dans le jeton dans un ClaimsIdentity objet.Validating security tokens (SecurityToken) of the type it is designed to process and packaging the claims contained in the token into a ClaimsIdentity object.

  • Sérialisation et désérialisation des jetons de sécurité du type qu’il est prévu de traiter.Serializing and deserializing security tokens of the type it is designed to process.

  • Sérialisation et désérialisation des clauses d’identificateur de clé ( SecurityKeyIdentifierClause ) qui font référence à des jetons du type qu’il est conçu pour traiter vers et à partir d' <wsse:SecurityTokenReference> éléments.Serializing and deserializing key identifier clauses (SecurityKeyIdentifierClause) that refer to tokens of the type it is designed to process to and from <wsse:SecurityTokenReference> elements.

  • Création de jetons de sécurité à partir d’un SecurityTokenDescriptor objet passé par les implémentations de la SecurityTokenService classe.Creating security tokens from a SecurityTokenDescriptor object passed by implementations of the SecurityTokenService class.

  • Création de clauses d’identificateur de clé à partir d’un jeton de sécurité pour les implémentations de la SecurityTokenService classe.Creating key identifier clauses from a security token for implementations of the SecurityTokenService class.

Windows Identity Foundation (WIF) fournit les gestionnaires de jetons de sécurité suivants prêts à l’emploi :Windows Identity Foundation (WIF) ships the following security token handlers out of the box:

La plupart de ces classes exposent des membres supplémentaires qui implémentent des fonctionnalités spécifiques au traitement des jetons pour lesquels la classe est conçue.Most of these classes expose additional members that implement functionality that is specific to the processing of the tokens for which the class is designed. Dans de nombreux cas, il peut être préférable de dériver à partir de l’une de ces classes plutôt que directement à partir de la SecurityTokenHandler classe.In many cases it may be better to derive from one of these classes rather than directly from the SecurityTokenHandler class.

Un gestionnaire de jetons de sécurité peut être ajouté ou supprimé d’une collection de gestionnaires de jetons en spécifiant les éléments < Add > , < Remove > ou < Clear > sous l’élément < securityTokenHandlers > dans un fichier de configuration.A security token handler can be added or removed from a token handler collection by specifying the <add>, <remove>, or <clear> elements under the <securityTokenHandlers> element in a configuration file. L' SecurityTokenHandlerConfiguration objet qui contient les paramètres de configuration de la collection de gestionnaires est accessible via la Configuration propriété et la collection de gestionnaires à laquelle le gestionnaire de jetons est membre est accessible à partir de la ContainingCollection propriété.The SecurityTokenHandlerConfiguration object that contains the configuration settings for the handler collection can be accessed through the Configuration property and the handler collection that the token handler is a member of can be accessed from the ContainingCollection property. Vous pouvez substituer la LoadCustomConfiguration méthode pour traiter tous les éléments de configuration personnalisés que votre gestionnaire prend.You can override the LoadCustomConfiguration method to process any custom configuration elements that your handler takes.

La SecurityTokenHandler classe expose plusieurs autres propriétés et méthodes.The SecurityTokenHandler class exposes several other properties and methods. Selon la fonctionnalité que vous choisissez d’implémenter, vous pouvez remplacer tout ou partie de ces membres.Depending on the functionality that you choose to implement, you may override some or all of these members.

Vous devez substituer la TokenType propriété et la GetTokenTypeIdentifiers méthode pour fournir à l’infrastructure WIF des informations sur le type de jeton de sécurité que votre classe est capable de traiter.You must override the TokenType property and the GetTokenTypeIdentifiers method to provide the WIF infrastructure with information about the type of security token that your class is designed to process.

La fonctionnalité de validation, de sérialisation et de désérialisation est exposée via des propriétés ou des méthodes qui indiquent si le gestionnaire peut exécuter une fonction spécifique associée à la méthode ou aux méthodes qui implémentent la fonctionnalité.Validation, serialization, and deserialization functionality is exposed through properties or methods that indicate whether the handler can perform a specific function combined with the method or methods that implement the functionality. La liste suivante associe les propriétés ou les méthodes qui indiquent les fonctionnalités à l’aide des méthodes qui implémentent cette fonctionnalité :The following list pairs the properties or methods that indicate functionality with the methods that implement that functionality:

Les CreateToken méthodes et CreateSecurityTokenReference sont appelées à partir du pipeline dans les implémentations de la SecurityTokenService classe.The CreateToken and the CreateSecurityTokenReference methods are called from the pipeline in implementations of the SecurityTokenService class.

La DetectReplayedToken méthode est appelée par l’infrastructure WIF pour déterminer si le jeton spécifié a déjà été reçu.The DetectReplayedToken method is called by the WIF infrastructure to determine whether the specified token has already been received. Par défaut, cette méthode retourne false , qui indique que le jeton n’a pas déjà été reçu.By default this method returns false, which indicates that the token has not already been received. Vous pouvez substituer la méthode et fournir une logique pour détecter les jetons relus.You can override the method and provide logic to detect replayed tokens.

Constructeurs

SecurityTokenHandler()

Appelée à partir des constructeurs des classes dérivées pour initialiser la classe SecurityTokenHandler.Called from constructors in derived classes to initialize the SecurityTokenHandler class.

Propriétés

CanValidateToken

Obtient une valeur indiquant si le gestionnaire prend en charge la validation des jetons de sécurité.Gets a value that indicates whether the handler supports validation of security tokens.

CanWriteToken

Obtient une valeur indiquant si le gestionnaire peut sérialiser les jetons de sécurité.Gets a value that indicates whether the handler can serialize security tokens.

Configuration

Obtient ou définit l'objet SecurityTokenHandlerConfiguration qui fournit la configuration pour l'instance actuelle.Gets or sets the SecurityTokenHandlerConfiguration object that provides configuration for the current instance.

ContainingCollection

Obtient la collection de gestionnaires de jetons qui contient l'instance actuelle.Gets the token handler collection that contains the current instance.

TokenType

En cas de substitution dans une classe dérivée, obtient le type de jeton de sécurité traité par cette instance.When overridden in a derived class, gets the type of the security token that is processed by this instance.

Méthodes

CanReadKeyIdentifierClause(XmlReader)

Retourne une valeur qui indique si l'élément XML dont il est fait référence par le lecteur XML spécifié est une clause de l'identificateur de clé qui peut être désérialisée par cette instance.Returns a value that indicates whether the XML element referred to by the specified XML reader is a key identifier clause that can be deserialized by this instance.

CanReadToken(String)

Retourne une valeur qui indique si la chaîne spécifiée peut être désérialisée comme un jeton du type traité par cette instance.Returns a value that indicates whether the specified string can be deserialized as a token of the type processed by this instance.

CanReadToken(XmlReader)

Retourne une valeur qui indique si l'élément XML référencé par le lecteur XML spécifié peut être lu comme un jeton du type traité par cette instance.Returns a value that indicates whether the XML element referenced by the specified XML reader can be read as a token of the type processed by this instance.

CanWriteKeyIdentifierClause(SecurityKeyIdentifierClause)

Retourne une valeur qui indique si la clause d'identificateur de clé spécifiée peut être sérialisée par cette instance.Returns a value that indicates whether the specified key identifier clause can be serialized by this instance.

CreateSecurityTokenReference(SecurityToken, Boolean)

En cas de substitution dans une classe dérivée, crée la référence de jeton de sécurité pour les jetons traités par cette classe.When overridden in a derived class, creates the security token reference for tokens processed by that class. Cette méthode est généralement appelée par un service d'émission de jeton de sécurité (STS).This method is typically called by a security token service (STS).

CreateToken(SecurityTokenDescriptor)

En cas de substitution dans une classe dérivée, crée un jeton de sécurité à l'aide descripteur de jetons spécifié.When overridden in a derived class, creates a security token using the specified token descriptor. Cette méthode est appelée par un service d'émission de jeton de sécurité (STS).This method is called by a security token service (STS).

DetectReplayedToken(SecurityToken)

En cas de substitution dans une classe dérivée, lève une exception si le jeton spécifié est identifié comme étant relu.When overridden in a derived class, throws an exception if the specified token is detected as being replayed.

Equals(Object)

Détermine si l'objet spécifié est égal à l'objet actuel.Determines whether the specified object is equal to the current object.

(Hérité de Object)
GetHashCode()

Sert de fonction de hachage par défaut.Serves as the default hash function.

(Hérité de Object)
GetTokenTypeIdentifiers()

En cas de substitution dans une classe dérivée, retourne l'ensemble des URI utilisés dans les demandes pour identifier un jeton du type traité par cette classe dérivée.When overridden in a derived class, returns the set of URIs that are used in requests to identify a token of the type processed by the derived class.

GetType()

Obtient le Type de l'instance actuelle.Gets the Type of the current instance.

(Hérité de Object)
LoadCustomConfiguration(XmlNodeList)

Après substitution dans une classe dérivée, charge la configuration personnalisée à partir de XML.When overridden in a derived class, loads custom configuration from XML.

MemberwiseClone()

Crée une copie superficielle du Object actuel.Creates a shallow copy of the current Object.

(Hérité de Object)
ReadKeyIdentifierClause(XmlReader)

En cas de substitution dans une classe dérivée, désérialise le XML référencé par le lecteur XML spécifié en clause d'identificateur de clé qui référence un jeton traité par la classe dérivée.When overridden in a derived class, deserializes the XML referenced by the specified XML reader to a key identifier clause that references a token processed by the derived class.

ReadToken(String)

En cas de substitution dans une classe dérivée, désérialise la chaîne spécifiée en un jeton du type traité par cette classe dérivée.When overridden in a derived class, deserializes the specified string to a token of the type processed by the derived class.

ReadToken(XmlReader)

En cas de substitution dans une classe dérivée, désérialise le XML référencé par le lecteur XML spécifié en un jeton du type traité par cette classe dérivée.When overridden in a derived class, deserializes the XML referenced by the specified XML reader to a token of the type processed by the derived class.

ReadToken(XmlReader, SecurityTokenResolver)

En cas de substitution dans une classe dérivée, désérialise le XML référencé par un lecteur XML spécifié en un jeton du type traité par cette classe dérivée à l'aide du lecteur XML et du programme de résolution de jetons spécifiés.When overridden in a derived class, deserializes the XML referenced by the specified XML reader to a token of the type processed by the derived class by using the specified token resolver.

ToString()

Retourne une chaîne qui représente l'objet actuel.Returns a string that represents the current object.

(Hérité de Object)
TraceTokenValidationFailure(SecurityToken, String)

Effectue le traçage de l'événement d'échec lors de la validation des jetons de sécurité lorsque le traçage est activé.Traces the failure event during the validation of security tokens when tracing is enabled.

TraceTokenValidationSuccess(SecurityToken)

Effectue le traçage de la validation réussie de l'événement de jetons de sécurité lorsque le traçage est activé.Traces the successful validation of security tokens event when tracing is enabled.

ValidateToken(SecurityToken)

En cas de substitution dans une classe dérivée,valide le jeton de sécurité spécifié.When overridden in a derived class, validates the specified security token. Le jeton doit être du type traité par la classe dérivée.The token must be of the type processed by the derived class.

WriteKeyIdentifierClause(XmlWriter, SecurityKeyIdentifierClause)

En cas de substitution dans une classe dérivée, sérialise la clause d'identificateur de clé spécifiée au format XML.When overridden in a derived class, serializes the specified key identifier clause to XML. La clause de l'identificateur de clé doit être du type pris en charge par la classe dérivée.The key identifier clause must be of the type supported by the derived class.

WriteToken(SecurityToken)

En cas de substitution dans une classe dérivée, sérialise le jeton de sécurité spécifié en chaîne.When overridden in a derived class, serializes the specified security token to a string. Le jeton doit être du type traité par la classe dérivée.The token must be of the type processed by the derived class.

WriteToken(XmlWriter, SecurityToken)

En cas de substitution dans une classe dérivée, sérialise le jeton de sécurité spécifié au format XML.When overridden in a derived class, serializes the specified security token to XML. Le jeton doit être du type traité par la classe dérivée.The token must be of the type processed by the derived class.

S’applique à

Voir aussi