TokenValidationParameters Klass
Definition
Viktigt
En del information gäller för förhandsversionen av en produkt och kan komma att ändras avsevärt innan produkten blir allmänt tillgänglig. Microsoft lämnar inga garantier, uttryckliga eller underförstådda, avseende informationen som visas här.
Innehåller en uppsättning parametrar som används av en SecurityTokenHandler när du validerar en SecurityToken.
public class TokenValidationParameters
type TokenValidationParameters = class
Public Class TokenValidationParameters
- Arv
-
TokenValidationParameters
Konstruktorer
| Name | Description |
|---|---|
| TokenValidationParameters() |
Initierar en ny instans av TokenValidationParameters klassen. |
| TokenValidationParameters(TokenValidationParameters) |
Kopiera konstruktorn för TokenValidationParameters. |
Fält
| Name | Description |
|---|---|
| DefaultAuthenticationType |
Det här är standardvärdet AuthenticationType för när du skapar en ClaimsIdentity.
Värdet är |
| DefaultClockSkew |
Standard för klockans skevhet. |
| DefaultMaximumTokenSizeInBytes |
Standard för den maximala tokenstorleken. |
Egenskaper
| Name | Description |
|---|---|
| ActorValidationParameters |
Hämtar eller anger TokenValidationParameters. |
| AlgorithmValidator |
Hämtar eller anger ett ombud som används för att verifiera den kryptografiska algoritm som används. |
| AudienceValidator |
Hämtar eller anger ett ombud som ska användas för att verifiera målgruppen. |
| AuthenticationType |
Hämtar eller anger AuthenticationType när du skapar en ClaimsIdentity. |
| ClockSkew |
Hämtar eller ställer in klockans skevhet som ska tillämpas när du validerar en tid. |
| ConfigurationManager |
Om den anges används den här egenskapen för att hämta utfärdaren och signeringsnycklarna som är associerade med metadataslutpunkten Issuerför . Den hämtade utfärdaren och signeringsnycklarna används sedan tillsammans med de som finns på TokenValidationParameters för validering av den inkommande token. |
| CryptoProviderFactory |
Användare kan åsidosätta standardvärdet CryptoProviderFactory med den här egenskapen. Den här fabriken används för att skapa signaturprovidrar. |
| DebugId |
Hämtar eller anger en sträng som hjälper dig att ange brytpunkter vid felsökning. |
| IgnoreTrailingSlashWhenValidatingAudience |
Hämtar eller anger ett booleskt värde som styr om ett /är betydande i slutet av målgruppen.
Standardvärdet är |
| IncludeTokenOnFailedValidation |
Hämtar eller anger flaggan som anger om verifieringen SecurityToken ska inkluderas när verifieringen misslyckas. |
| InstancePropertyBag |
Hämtar en IDictionary<TKey,TValue> som är unik för den här instansen. Anrop Clone() resulterar i en ny instans av denna IDictionary. |
| IsClone |
Hämtar ett värde som anger om Clone() anropades för att hämta den här instansen. |
| IssuerSigningKey |
Hämtar eller anger SecurityKey det som ska användas för signaturverifiering. |
| IssuerSigningKeyResolver |
Hämtar eller anger ett ombud som ska anropas för att hämta en SecurityKey som används för signaturverifiering. |
| IssuerSigningKeyResolverUsingConfiguration |
Hämtar eller anger ett ombud som ska anropas för att hämta en SecurityKey som används för signaturverifiering med hjälp av TokenValidationParameters och BaseConfiguration. |
| IssuerSigningKeys |
Hämtar eller anger en IEnumerable<T> som används för signaturverifiering. |
| IssuerSigningKeyValidator |
Hämtar eller anger ett ombud för validering av token SecurityKey som signerats. |
| IssuerSigningKeyValidatorUsingConfiguration |
Hämtar eller anger ett ombud för validering av token SecurityKey som signerats. |
| IssuerValidator |
Hämtar eller anger ett ombud som ska användas för att verifiera utfärdaren av token. |
| IssuerValidatorUsingConfiguration |
Hämtar eller anger ett ombud som ska användas för att verifiera utfärdaren av token. |
| LifetimeValidator |
Hämtar eller anger ett ombud som ska användas för att verifiera tokens livslängd |
| LogTokenId |
Hämtar eller anger ett Boolean som avgör om tokenidentifieraranspråket måste loggas.
Standardvärdet är |
| LogValidationExceptions |
Hämtar eller anger ett Boolean som avgör om valideringsfel måste loggas som ett fel.
Standardvärdet är |
| NameClaimType |
Hämtar eller anger en String som definierar NameClaimType. |
| NameClaimTypeRetriever |
Hämtar eller anger ett ombud som ska anropas för att ange egenskapen NameClaimType när en token har verifierats. |
| PropertyBag |
Hämtar eller anger IDictionary<TKey,TValue> som innehåller en samling anpassade nyckel/värde-par. På så sätt kan du lägga till parametrar som kan användas i scenarier för validering av anpassade token. |
| RefreshBeforeValidation |
Hämtar eller anger ett booleskt värde som ska styra om konfigurationen måste uppdateras före tokenverifiering. |
| RequireAudience |
Hämtar eller anger ett värde som anger om SAML- eller JWT-token måste ha minst en AudienceRestriction.
Standardvärdet är |
| RequireExpirationTime |
Hämtar eller anger ett värde som anger om token måste ha ett "förfallovärde".
Standardvärdet är |
| RequireSignedTokens |
Hämtar eller anger ett värde som anger om en SecurityToken kan betraktas som giltig om den inte är signerad.
Standardvärdet är |
| RoleClaimType |
Hämtar eller anger String som definierar RoleClaimType. |
| RoleClaimTypeRetriever |
Hämtar eller anger ett ombud som ska anropas för att ange egenskapen RoleClaimType när en token har verifierats. |
| SaveSigninToken |
Hämtar eller anger ett booleskt värde för att kontrollera om den ursprungliga token ska sparas när säkerhetstoken har verifierats. |
| SignatureValidator |
Hämtar eller anger ett ombud som ska användas för att verifiera tokens signatur. |
| SignatureValidatorUsingConfiguration |
Hämtar eller anger ett ombud som ska användas för att verifiera tokens signatur med hjälp TokenValidationParameters av och BaseConfiguration. |
| TokenDecryptionKey |
Hämtar eller anger SecurityKey det som ska användas för dekryptering. |
| TokenDecryptionKeyResolver |
Hämtar eller anger ett ombud som anropas för att hämta en SecurityKey som används för dekryptering. |
| TokenDecryptionKeys |
Hämtar eller anger IEnumerable<T> det som ska användas för dekryptering av inkommande token. |
| TokenReader |
Hämtar eller anger ett ombud som ska användas för att läsa token. |
| TokenReplayCache |
Hämtar eller ställer in lagringstoken ITokenReplayCache som kan kontrolleras för att identifiera tokenrepris. |
| TokenReplayValidator |
Hämtar eller anger ett ombud som ska användas för att verifiera tokenreprisen för token |
| TransformBeforeSignatureValidation |
Hämtar eller anger ett ombud som ska anropas för att omvandla en token till ett format som stöds före validering. |
| TryAllDecryptionKeys |
Hämtar eller anger ett värde som anger om alla TokenDecryptionKeys ska provas under tokendekryptering när en nyckel inte matchas med token "kid" eller om token "kid" är tom.
Standardvärdet är |
| TryAllIssuerSigningKeys |
Hämtar eller anger ett värde som anger om allt IssuerSigningKeys ska provas under signaturverifieringen när en nyckel inte matchas med token "kid" eller om token "kid" är tom.
Standardvärdet är |
| TryReadJwtClaim |
Hämtar eller anger det ombud som ska anropas när du läser JSON-webbtokenhuvud och nyttolastanspråk. |
| TypeValidator |
Hämtar eller anger ett ombud som ska användas för att verifiera tokentypen. Om tokentypen inte kan verifieras måste ett undantag genereras av ombudet. Obs! Parametern "type" kan vara null om den inte kunde extraheras från den vanliga platsen. Implementeringar som behöver lösa det från en annan plats kan använda parametern "token". |
| ValidAlgorithms |
Hämtar eller anger giltiga algoritmer för kryptografiska åtgärder. |
| ValidateActor |
Hämtar eller anger ett värde som anger om en aktörstoken identifieras, om den ska verifieras.
Standardvärdet är |
| ValidateAudience |
Hämtar eller anger ett booleskt värde för att kontrollera om målgruppen ska verifieras under tokenverifieringen. |
| ValidateIssuer |
Hämtar eller anger ett booleskt värde för att kontrollera om utfärdaren ska verifieras under tokenverifieringen. |
| ValidateIssuerSigningKey |
Hämtar eller anger ett booleskt värde som styr om valideringen av SecurityKey den som signerade securityToken anropas. |
| ValidateLifetime |
Hämtar eller anger ett booleskt värde för att kontrollera om livslängden ska verifieras under tokenverifieringen. |
| ValidateSignatureLast |
Hämtar eller anger ett booleskt värde som styr valideringsordningen för nyttolasten och signaturen under tokenverifieringen. |
| ValidateTokenReplay |
Hämtar eller anger ett booleskt värde för att kontrollera om tokenreprisen ska verifieras under tokenverifieringen. |
| ValidateWithLKG |
Hämtar eller anger ett booleskt värde för att kontrollera om LKG-konfigurationen ska användas för tokenverifiering. |
| ValidAudience |
Hämtar eller anger en sträng som representerar en giltig målgrupp som ska användas för att kontrollera mot tokens målgrupp.
Standardvärdet är |
| ValidAudiences |
Hämtar eller anger IEnumerable<T> som innehåller giltiga målgrupper som ska användas för att kontrollera mot tokens målgrupp.
Standardvärdet är |
| ValidIssuer |
Hämtar eller anger en String som representerar en giltig utfärdare som ska användas för att kontrollera mot tokens utfärdare.
Standardvärdet är |
| ValidIssuers |
Hämtar eller anger IEnumerable<T> som innehåller giltiga utfärdare som ska användas för att kontrollera mot tokens utfärdare.
Standardvärdet är |
| ValidTypes |
Hämtar eller anger som IEnumerable<T> innehåller giltiga typer som ska användas för att kontrollera mot JWT-huvudets typanspråk.
Om den här egenskapen inte har angetts verifieras inte huvudanspråket "typ" och alla typer accepteras.
När det gäller en JWE gäller den här egenskapen ENDAST för den inre tokenrubriken.
Standardvärdet är |
Metoder
| Name | Description |
|---|---|
| Clone() |
Returnerar en ny instans av TokenValidationParameters med värden som kopierats från det här objektet. |
| CreateClaimsIdentity(SecurityToken, String) |
Skapar en ClaimsIdentity användning: "NameClaimType": Om NameClaimTypeRetriever har angetts anropar du ombudet, anropar annars NameClaimType. Om resultatet är en null- eller tom sträng använder du DefaultNameClaimType ."RoleClaimType": Om RoleClaimTypeRetriever har angetts anropar du ombudet, anropar annars RoleClaimType. Om resultatet är en null- eller tom sträng använder du DefaultRoleClaimType . |
Tilläggsmetoder
| Name | Description |
|---|---|
| EnableAadSigningKeyIssuerValidation(TokenValidationParameters) |
Aktiverar verifiering av utfärdaren av signeringsnycklarna som används av Microsofts identitetsplattform (AAD) mot utfärdaren av token. |
| EnableEntraIdSigningKeyCloudInstanceValidation(TokenValidationParameters) |
Aktiverar validering av molninstansen av Microsoft Entra ID tokensigneringsnycklar. |