TokenValidationParameters Classe
Définition
Important
Certaines informations portent sur la préversion du produit qui est susceptible d’être en grande partie modifiée avant sa publication. Microsoft exclut toute garantie, expresse ou implicite, concernant les informations fournies ici.
Contient un ensemble de paramètres utilisés par un SecurityTokenHandler lors de la validation d’un SecurityToken.
public class TokenValidationParameters
type TokenValidationParameters = class
Public Class TokenValidationParameters
- Héritage
-
TokenValidationParameters
Constructeurs
| Nom | Description |
|---|---|
| TokenValidationParameters() |
Initialise une nouvelle instance de la classe TokenValidationParameters. |
| TokenValidationParameters(TokenValidationParameters) |
Constructeur de copie pour TokenValidationParameters. |
Champs
| Nom | Description |
|---|---|
| DefaultAuthenticationType |
Il s’agit de la valeur par défaut de AuthenticationType la création d’un ClaimsIdentity.
La valeur est |
| DefaultClockSkew |
Valeur par défaut de l’asymétrie de l’horloge. |
| DefaultMaximumTokenSizeInBytes |
Valeur par défaut pour la taille maximale du jeton. |
Propriétés
| Nom | Description |
|---|---|
| ActorValidationParameters |
Obtient ou définit TokenValidationParameters. |
| AlgorithmValidator |
Obtient ou définit un délégué utilisé pour valider l’algorithme de chiffrement utilisé. |
| AudienceValidator |
Obtient ou définit un délégué qui sera utilisé pour valider l’audience. |
| AuthenticationType |
Obtient ou définit l’AuthenticationType lors de la création d’un ClaimsIdentity. |
| ClockSkew |
Obtient ou définit l’asymétrie de l’horloge à appliquer lors de la validation d’une heure. |
| ConfigurationManager |
Si elle est définie, cette propriété est utilisée pour obtenir l’émetteur et les clés de signature associées au point de terminaison de métadonnées de Issuer. L’émetteur obtenu et les clés de signature seront ensuite utilisées avec celles présentes sur tokenValidationParameters pour la validation du jeton entrant. |
| CryptoProviderFactory |
Les utilisateurs peuvent remplacer la valeur par défaut CryptoProviderFactory par cette propriété. Cette fabrique sera utilisée pour créer des fournisseurs de signatures. |
| DebugId |
Obtient ou définit une chaîne qui permet de définir des points d’arrêt lors du débogage. |
| IgnoreTrailingSlashWhenValidatingAudience |
Obtient ou définit une valeur booléenne qui contrôle si un « / » est significatif à la fin de l’audience.
La valeur par défaut est |
| IncludeTokenOnFailedValidation |
Obtient ou définit l’indicateur qui indique s’il faut inclure le SecurityToken moment où la validation échoue. |
| InstancePropertyBag |
Obtient un IDictionary<TKey,TValue> élément unique à cette instance. L’appel Clone() entraîne une nouvelle instance de cet IDictionary. |
| IsClone |
Obtient une valeur indiquant si Clone() elle a été appelée pour obtenir cette instance. |
| IssuerSigningKey |
Obtient ou définit la SecurityKey valeur à utiliser pour la validation de signature. |
| IssuerSigningKeyResolver |
Obtient ou définit un délégué qui sera appelé pour récupérer un SecurityKey paramètre utilisé pour la validation de signature. |
| IssuerSigningKeyResolverUsingConfiguration |
Obtient ou définit un délégué qui sera appelé pour récupérer un SecurityKey paramètre utilisé pour la validation de signature à l’aide de l’instruction TokenValidationParameters et BaseConfiguration. |
| IssuerSigningKeys |
Obtient ou définit une IEnumerable<T> valeur utilisée pour la validation de signature. |
| IssuerSigningKeyValidator |
Obtient ou définit un délégué pour valider le SecurityKey jeton qui a signé le jeton. |
| IssuerSigningKeyValidatorUsingConfiguration |
Obtient ou définit un délégué pour valider le SecurityKey jeton qui a signé le jeton. |
| IssuerValidator |
Obtient ou définit un délégué qui sera utilisé pour valider l’émetteur du jeton. |
| IssuerValidatorUsingConfiguration |
Obtient ou définit un délégué qui sera utilisé pour valider l’émetteur du jeton. |
| LifetimeValidator |
Obtient ou définit un délégué qui sera utilisé pour valider la durée de vie du jeton |
| LogTokenId |
Obtient ou définit une Boolean valeur qui décidera si la revendication d’identificateur de jeton doit être journalisée.
La valeur par défaut est |
| LogValidationExceptions |
Obtient ou définit une valeur Boolean qui décidera si l’échec de validation doit être journalisé en tant qu’erreur.
La valeur par défaut est |
| NameClaimType |
Obtient ou définit un String qui définit le NameClaimType. |
| NameClaimTypeRetriever |
Obtient ou définit un délégué qui sera appelé pour définir la propriété NameClaimType après avoir validé un jeton. |
| PropertyBag |
Obtient ou définit la IDictionary<TKey,TValue> collection de paires clé/valeur personnalisées. Cela permet l’ajout de paramètres qui peuvent être utilisés dans des scénarios de validation de jetons personnalisés. |
| RefreshBeforeValidation |
Obtient ou définit une valeur booléenne pour contrôler si la configuration doit être actualisée avant la validation du jeton. |
| RequireAudience |
Obtient ou définit une valeur indiquant si les jetons SAML ou JWT doivent avoir au moins une audienceRestriction.
La valeur par défaut est |
| RequireExpirationTime |
Obtient ou définit une valeur indiquant si les jetons doivent avoir une valeur « expiration ».
La valeur par défaut est |
| RequireSignedTokens |
Obtient ou définit une valeur indiquant si une SecurityToken valeur peut être considérée comme valide si elle n’est pas signée.
La valeur par défaut est |
| RoleClaimType |
Obtient ou définit l’objet String qui définit le RoleClaimType. |
| RoleClaimTypeRetriever |
Obtient ou définit un délégué qui sera appelé pour définir la propriété RoleClaimType après avoir validé un jeton. |
| SaveSigninToken |
Obtient ou définit une valeur booléenne à contrôler si le jeton d’origine doit être enregistré après la validation du jeton de sécurité. |
| SignatureValidator |
Obtient ou définit un délégué qui sera utilisé pour valider la signature du jeton. |
| SignatureValidatorUsingConfiguration |
Obtient ou définit un délégué qui sera utilisé pour valider la signature du jeton à l’aide du TokenValidationParameters et du BaseConfiguration. |
| TokenDecryptionKey |
Obtient ou définit l’élément SecurityKey à utiliser pour le déchiffrement. |
| TokenDecryptionKeyResolver |
Obtient ou définit un délégué qui sera appelé pour récupérer un SecurityKey élément utilisé pour le déchiffrement. |
| TokenDecryptionKeys |
Obtient ou définit la IEnumerable<T> valeur à utiliser pour déchiffrer les jetons entrants. |
| TokenReader |
Obtient ou définit un délégué qui sera utilisé pour lire le jeton. |
| TokenReplayCache |
Obtient ou définit les ITokenReplayCache jetons qui peuvent être vérifiés pour détecter la relecture des jetons. |
| TokenReplayValidator |
Obtient ou définit un délégué qui sera utilisé pour valider la relecture du jeton |
| TransformBeforeSignatureValidation |
Obtient ou définit un délégué qui sera appelé pour transformer un jeton dans un format pris en charge avant la validation. |
| TryAllDecryptionKeys |
Obtient ou définit une valeur indiquant si tous TokenDecryptionKeys doivent être essayés pendant le déchiffrement du jeton lorsqu’une clé n’est pas mise en correspondance avec le jeton « kid » ou si le jeton « kid » est vide.
La valeur par défaut est |
| TryAllIssuerSigningKeys |
Obtient ou définit une valeur indiquant si tout IssuerSigningKeys doit être essayé lors de la validation de signature lorsqu’une clé n’est pas mise en correspondance avec le jeton « kid » ou si le jeton « kid » est vide.
La valeur par défaut est |
| TryReadJwtClaim |
Obtient ou définit le délégué qui sera appelé lors de la lecture de l’en-tête de jeton web JSON et des revendications de charge utile. |
| TypeValidator |
Obtient ou définit un délégué qui sera utilisé pour valider le type du jeton. Si le type de jeton ne peut pas être validé, une exception DOIT être levée par le délégué. Remarque : le paramètre « type » peut être null s’il n’a pas pu être extrait de son emplacement habituel. Les implémentations qui doivent la résoudre à partir d’un autre emplacement peuvent utiliser le paramètre « token ». |
| ValidAlgorithms |
Obtient ou définit les algorithmes valides pour les opérations de chiffrement. |
| ValidateActor |
Obtient ou définit une valeur indiquant si un jeton d’acteur est détecté, s’il doit être validé.
La valeur par défaut est |
| ValidateAudience |
Obtient ou définit une valeur booléenne à contrôler si l’audience sera validée lors de la validation du jeton. |
| ValidateIssuer |
Obtient ou définit une valeur booléenne à contrôler si l’émetteur sera validé pendant la validation du jeton. |
| ValidateIssuerSigningKey |
Obtient ou définit une valeur booléenne qui contrôle si la validation de l’objet SecurityKey securityToken signé est appelée. |
| ValidateLifetime |
Obtient ou définit une valeur booléenne à contrôler si la durée de vie sera validée pendant la validation du jeton. |
| ValidateSignatureLast |
Obtient ou définit une valeur booléenne qui contrôle l’ordre de validation de la charge utile et de la signature pendant la validation du jeton. |
| ValidateTokenReplay |
Obtient ou définit une valeur booléenne pour contrôler si la relecture du jeton sera validée pendant la validation du jeton. |
| ValidateWithLKG |
Obtient ou définit une valeur booléenne à contrôler si la configuration LKG sera utilisée pour la validation de jeton. |
| ValidAudience |
Obtient ou définit une chaîne qui représente une audience valide qui sera utilisée pour vérifier l’audience du jeton.
La valeur par défaut est |
| ValidAudiences |
Obtient ou définit les IEnumerable<T> audiences valides qui seront utilisées pour vérifier l’audience du jeton.
La valeur par défaut est |
| ValidIssuer |
Obtient ou définit un String qui représente un émetteur valide qui sera utilisé pour vérifier l’émetteur du jeton.
La valeur par défaut est |
| ValidIssuers |
Obtient ou définit les IEnumerable<T> émetteurs valides qui seront utilisés pour vérifier l’émetteur du jeton.
La valeur par défaut est |
| ValidTypes |
Obtient ou définit les IEnumerable<T> types valides qui seront utilisés pour vérifier la revendication « typ » de l’en-tête JWT.
Si cette propriété n’est pas définie, la revendication d’en-tête « typ » n’est pas validée et tous les types sont acceptés.
Dans le cas d’une instance JWE, cette propriété s’applique uniquement à l’en-tête de jeton interne.
La valeur par défaut est |
Méthodes
| Nom | Description |
|---|---|
| Clone() |
Retourne une nouvelle instance contenant des TokenValidationParameters valeurs copiées à partir de cet objet. |
| CreateClaimsIdentity(SecurityToken, String) |
Crée une ClaimsIdentity utilisation : 'NameClaimType' : si NameClaimTypeRetriever est défini, appelez délégué, sinon appelez NameClaimType. Si le résultat est une chaîne null ou vide, utilisez DefaultNameClaimType .« RoleClaimType » : si RoleClaimTypeRetriever est défini, appelez délégué, sinon appelez RoleClaimType. Si le résultat est une chaîne null ou vide, utilisez DefaultRoleClaimType . |
Méthodes d’extension
| Nom | Description |
|---|---|
| EnableAadSigningKeyIssuerValidation(TokenValidationParameters) |
Active la validation de l’émetteur des clés de signature utilisées par l’Plateforme d'identités Microsoft (AAD) par rapport à l’émetteur du jeton. |
| EnableEntraIdSigningKeyCloudInstanceValidation(TokenValidationParameters) |
Active la validation de l’instance cloud des clés de signature de jeton Microsoft Entra ID. |