TokenValidationParameters Klasse

Definition

Namespace:: Microsoft.IdentityModel.Tokens

Assembly:: Microsoft.IdentityModel.Tokens.dll

Paket:: Microsoft.IdentityModel.Tokens v8.19.1

Wichtig

Einige Informationen beziehen sich auf Vorabversionen, die vor dem Release ggf. grundlegend überarbeitet werden. Microsoft übernimmt hinsichtlich der hier bereitgestellten Informationen keine Gewährleistungen, seien sie ausdrücklich oder konkludent.

Enthält einen Satz von Parametern, die bei der SecurityTokenHandler Überprüfung einer SecurityToken.

public class TokenValidationParameters

type TokenValidationParameters = class

Public Class TokenValidationParameters

Vererbung: Object
TokenValidationParameters

Konstruktoren

Name	Beschreibung
TokenValidationParameters()	Initialisiert eine neue Instanz der TokenValidationParameters-Klasse.
TokenValidationParameters(TokenValidationParameters)	Copy-Konstruktor für TokenValidationParameters.

Felder

Name	Beschreibung
DefaultAuthenticationType	Dies ist der Standardwert beim AuthenticationType Erstellen eines ClaimsIdentity. Der Wert ist `"AuthenticationTypes.Federation"`. Um den Wert zu ändern, legen Sie diesen AuthenticationType auf einen anderen Wert fest.
DefaultClockSkew	Standard für die Uhrneigung.
DefaultMaximumTokenSizeInBytes	Standard für die maximale Tokengröße.

Eigenschaften

Name	Beschreibung
ActorValidationParameters	Ruft ab oder legt fest TokenValidationParameters.
AlgorithmValidator	Ruft einen Delegaten ab, der zum Überprüfen des verwendeten Kryptografiealgorithmus verwendet wird, oder legt diesen fest.
AudienceValidator	Dient zum Abrufen oder Festlegen eines Delegaten, der zum Überprüfen der Zielgruppe verwendet wird.
AuthenticationType	Ruft ab oder legt den AuthenticationType beim Erstellen einer ClaimsIdentity.
ClockSkew	Dient zum Abrufen oder Festlegen der Uhr-Schiefe, die beim Überprüfen einer Zeit angewendet werden soll.
ConfigurationManager	Wenn diese Eigenschaft festgelegt ist, wird diese Eigenschaft verwendet, um den Aussteller und die Signaturschlüssel abzurufen, die dem Metadatenendpunkt zugeordnet Issuersind. Die erhaltenen Aussteller- und Signaturschlüssel werden dann zusammen mit den in den TokenValidationParameters vorhandenen Schlüsseln zur Überprüfung des eingehenden Tokens verwendet.
CryptoProviderFactory	Benutzer können die Standardeinstellung CryptoProviderFactory mit dieser Eigenschaft überschreiben. Diese Factory wird zum Erstellen von Signaturanbietern verwendet.
DebugId	Dient zum Abrufen oder Festlegen einer Zeichenfolge, die beim Festlegen von Haltepunkten beim Debuggen hilft.
IgnoreTrailingSlashWhenValidatingAudience	Dient zum Abrufen oder Festlegen eines werts vom Typ Boolean, der steuert, ob ein "/" am Ende der Zielgruppe signifikant ist. Der Standardwert lautet `true`.
IncludeTokenOnFailedValidation	Dient zum Abrufen oder Festlegen des Flags, das angibt, ob die SecurityToken Überprüfung fehlschlägt.
InstancePropertyBag	Ruft ein IDictionary<TKey,TValue> , das für diese Instanz eindeutig ist. Das Aufrufen Clone() führt zu einer neuen Instanz dieses IDictionarys.
IsClone	Ruft einen Wert ab, der angibt, ob Clone() zum Abrufen dieser Instanz aufgerufen wurde.
IssuerSigningKey	Ruft ab oder legt fest, die für die SecurityKey Signaturüberprüfung verwendet werden soll.
IssuerSigningKeyResolver	Dient zum Abrufen oder Festlegen eines Delegaten, der aufgerufen wird, um eine für die SecurityKey Signaturüberprüfung verwendete Abzurufen.
IssuerSigningKeyResolverUsingConfiguration	Dient zum Abrufen oder Festlegen eines Delegaten, der aufgerufen wird, um eine SecurityKey für die Signaturüberprüfung verwendete Signaturüberprüfung mithilfe der und .TokenValidationParameters BaseConfiguration
IssuerSigningKeys	Dient zum Abrufen oder Festlegen eines für die IEnumerable<T> Signaturüberprüfung verwendeten Werts.
IssuerSigningKeyValidator	Dient zum Abrufen oder Festlegen eines Delegaten zum Überprüfen des Token, das SecurityKey das Token signiert hat.
IssuerSigningKeyValidatorUsingConfiguration	Dient zum Abrufen oder Festlegen eines Delegaten zum Überprüfen des Token, das SecurityKey das Token signiert hat.
IssuerValidator	Dient zum Abrufen oder Festlegen eines Delegaten, der zum Überprüfen des Ausstellers des Tokens verwendet wird.
IssuerValidatorUsingConfiguration	Dient zum Abrufen oder Festlegen eines Delegaten, der zum Überprüfen des Ausstellers des Tokens verwendet wird.
LifetimeValidator	Dient zum Abrufen oder Festlegen eines Delegaten, der verwendet wird, um die Lebensdauer des Tokens zu überprüfen.
LogTokenId	Dient zum Abrufen oder Festlegen eines Boolean Werts, der bestimmt, ob der Tokenbezeichneranspruch protokolliert werden muss. Der Standardwert ist `true`.
LogValidationExceptions	Dient zum Abrufen oder Festlegen eines Boolean Werts, der entscheidet, ob ein Überprüfungsfehler als Fehler protokolliert werden muss. Der Standardwert ist `true` für die Abwärtskompatibilität des Verhaltens vorgesehen. Wenn dieser Wert auf "false" festgelegt ist, werden Überprüfungsfehler als Informationen protokolliert und dann ausgelöst.
NameClaimType	Dient zum Abrufen oder Festlegen eines String Werts, der die NameClaimType.
NameClaimTypeRetriever	Dient zum Abrufen oder Festlegen eines Delegaten, der aufgerufen wird, um die Eigenschaft NameClaimType nach der Überprüfung eines Tokens festzulegen.
PropertyBag	Dient zum Abrufen oder Festlegen der IDictionary<TKey,TValue> Auflistung von benutzerdefinierten Schlüssel-Wert-Paaren. Dies ermöglicht das Hinzufügen von Parametern, die in benutzerdefinierten Tokenüberprüfungsszenarien verwendet werden können.
RefreshBeforeValidation	Dient zum Abrufen oder Festlegen eines Werts vom Typ Boolean, der gesteuert werden soll, wenn die Konfiguration vor der Tokenüberprüfung aktualisiert werden muss.
RequireAudience	Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob SAML- oder JWT-Token mindestens eine AudienceRestriction aufweisen müssen. Der Standardwert lautet `true`.
RequireExpirationTime	Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob Token einen "Ablaufwert" aufweisen müssen. Der Standardwert lautet `true`.
RequireSignedTokens	Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob ein SecurityToken Wert als gültig betrachtet werden kann, wenn er nicht signiert ist. Der Standardwert lautet `true`.
RoleClaimType	Dient zum Abrufen oder Festlegen der String Definition der RoleClaimType.
RoleClaimTypeRetriever	Dient zum Abrufen oder Festlegen eines Delegaten, der aufgerufen wird, um die Eigenschaft RoleClaimType nach der Überprüfung eines Tokens festzulegen.
SaveSigninToken	Ruft einen booleschen Wert ab, der steuert, ob das ursprüngliche Token gespeichert werden soll, nachdem das Sicherheitstoken überprüft wurde, oder legt diesen fest.
SignatureValidator	Dient zum Abrufen oder Festlegen eines Delegaten, der zum Überprüfen der Signatur des Tokens verwendet wird.
SignatureValidatorUsingConfiguration	Dient zum Abrufen oder Festlegen eines Delegaten, der verwendet wird, um die Signatur des Tokens mithilfe TokenValidationParameters der und der .BaseConfiguration
TokenDecryptionKey	Ruft ab oder legt fest, die SecurityKey für die Entschlüsselung verwendet werden soll.
TokenDecryptionKeyResolver	Dient zum Abrufen oder Festlegen eines Delegaten, der aufgerufen wird, um eine SecurityKey zum Entschlüsseln verwendete Funktion abzurufen.
TokenDecryptionKeys	Ruft ab oder legt fest, die IEnumerable<T> zum Entschlüsseln eingehender Token verwendet werden soll.
TokenReader	Dient zum Abrufen oder Festlegen eines Delegaten, der zum Lesen des Tokens verwendet wird.
TokenReplayCache	Dient zum Abrufen oder Festlegen der ITokenReplayCache Speichertoken, die überprüft werden können, um die Tokenwiedergabe zu erkennen.
TokenReplayValidator	Dient zum Abrufen oder Festlegen eines Delegaten, der verwendet wird, um die Tokenwiedergabe des Tokens zu überprüfen.
TransformBeforeSignatureValidation	Dient zum Abrufen oder Festlegen eines Delegaten, der aufgerufen wird, um ein Token in ein unterstütztes Format zu transformieren, bevor die Überprüfung erfolgt.
TryAllDecryptionKeys	Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob alle TokenDecryptionKeys während der Tokenentschlüsselung versucht werden sollen, wenn ein Schlüssel nicht mit dem Token "kid" übereinstimmt oder ob das Token "Kid" leer ist. Der Standardwert lautet `true`.
TryAllIssuerSigningKeys	Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob alle IssuerSigningKeys während der Signaturüberprüfung versucht werden sollen, wenn ein Schlüssel nicht mit dem Token "kid" übereinstimmt oder ob das Token "kid" leer ist. Der Standardwert lautet `true`.
TryReadJwtClaim	Ruft den Delegaten ab, der beim Lesen von JSON-Webtokenheader- und Nutzlastansprüchen aufgerufen wird, oder legt diesen fest.
TypeValidator	Dient zum Abrufen oder Festlegen eines Delegaten, der verwendet wird, um den Typ des Tokens zu überprüfen. Wenn der Tokentyp nicht überprüft werden kann, muss eine Ausnahme vom Delegaten ausgelöst werden. Hinweis: Der Parameter 'type' kann null sein, wenn er nicht von seinem üblichen Speicherort extrahiert werden konnte. Implementierungen, die sie von einem anderen Speicherort auflösen müssen, können den Parameter "token" verwenden.
ValidAlgorithms	Dient zum Abrufen oder Festlegen der gültigen Algorithmen für kryptografische Vorgänge.
ValidateActor	Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob ein Akteurtoken erkannt wird, ob es überprüft werden soll. Der Standardwert lautet `false`.
ValidateAudience	Ruft einen booleschen Wert ab oder legt diesen fest, um zu steuern, ob die Zielgruppe während der Tokenüberprüfung überprüft wird.
ValidateIssuer	Ruft einen booleschen Wert ab, der gesteuert wird, wenn der Aussteller während der Tokenüberprüfung überprüft wird, oder legt diesen fest.
ValidateIssuerSigningKey	Dient zum Abrufen oder Festlegen eines Werts vom Typ Boolean, der steuert, ob die Überprüfung des SecurityKey signierten securityToken aufgerufen wird.
ValidateLifetime	Ruft einen booleschen Wert ab oder legt diesen fest, um zu steuern, ob die Lebensdauer während der Tokenüberprüfung überprüft wird.
ValidateSignatureLast	Dient zum Abrufen oder Festlegen eines Werts vom Typ Boolean, der die Überprüfungsreihenfolge der Nutzlast und Signatur während der Tokenüberprüfung steuert.
ValidateTokenReplay	Ruft einen booleschen Wert ab oder legt diesen fest, um zu steuern, ob die Tokenwiedergabe während der Tokenüberprüfung überprüft wird.
ValidateWithLKG	Ruft einen booleschen Wert ab, der gesteuert werden soll, wenn die LKG-Konfiguration für die Tokenüberprüfung verwendet wird, oder legt diesen fest.
ValidAudience	Dient zum Abrufen oder Festlegen einer Zeichenfolge, die eine gültige Zielgruppe darstellt, die verwendet wird, um die Benutzergruppe des Tokens zu überprüfen. Der Standardwert lautet `null`.
ValidAudiences	Dient zum Abrufen oder Festlegen der Gruppe, die IEnumerable<T> gültige Zielgruppen enthält, die verwendet werden, um die Benutzergruppe des Tokens zu überprüfen. Der Standardwert lautet `null`.
ValidIssuer	Dient zum Abrufen oder Festlegen eines String Werts, der einen gültigen Aussteller darstellt, der verwendet wird, um den Aussteller des Tokens zu überprüfen. Der Standardwert lautet `null`.
ValidIssuers	Dient zum Abrufen oder Festlegen der Eigenschaft, die IEnumerable<T> gültige Aussteller enthält, die verwendet werden, um den Aussteller des Tokens zu überprüfen. Der Standardwert lautet `null`.
ValidTypes	Dient zum Abrufen oder Festlegen der Eigenschaft, die IEnumerable<T> gültige Typen enthält, mit denen der JWT-Header den "typ"-Anspruch überprüft. Wenn diese Eigenschaft nicht festgelegt ist, wird der Headeranspruch "typ" nicht überprüft, und alle Typen werden akzeptiert. Bei einem JWE gilt diese Eigenschaft NUR für den inneren Tokenheader. Der Standardwert lautet `null`.

Methoden

Name	Beschreibung
Clone()	Gibt eine neue Instanz mit Werten zurück, die TokenValidationParameters aus diesem Objekt kopiert wurden.
CreateClaimsIdentity(SecurityToken, String)	Erstellt eine ClaimsIdentity Verwendung: AuthenticationType 'NameClaimType': Wenn NameClaimTypeRetriever festgelegt ist, rufen Sie Stellvertretung auf, andernfalls nameClaimType. Wenn das Ergebnis eine NULL- oder leere Zeichenfolge ist, verwenden Sie DefaultNameClaimType . 'RoleClaimType': Wenn RoleClaimTypeRetriever festgelegt ist, rufen Sie die Stellvertretung auf, oder rufen Sie RoleClaimType auf. Wenn das Ergebnis eine NULL- oder leere Zeichenfolge ist, verwenden Sie DefaultRoleClaimType .

Name

Beschreibung

Clone()

Gibt eine neue Instanz mit Werten zurück, die TokenValidationParameters aus diesem Objekt kopiert wurden.

CreateClaimsIdentity(SecurityToken, String)

Erstellt eine ClaimsIdentity Verwendung:

AuthenticationType

'NameClaimType': Wenn NameClaimTypeRetriever festgelegt ist, rufen Sie Stellvertretung auf, andernfalls nameClaimType. Wenn das Ergebnis eine NULL- oder leere Zeichenfolge ist, verwenden Sie DefaultNameClaimType

'RoleClaimType': Wenn RoleClaimTypeRetriever festgelegt ist, rufen Sie die Stellvertretung auf, oder rufen Sie RoleClaimType auf. Wenn das Ergebnis eine NULL- oder leere Zeichenfolge ist, verwenden Sie DefaultRoleClaimType

Erweiterungsmethoden

Name	Beschreibung
EnableAadSigningKeyIssuerValidation(TokenValidationParameters)	Aktiviert die Überprüfung des Ausstellers der von der Microsoft Identity Platform (AAD) verwendeten Signaturschlüssel für den Aussteller des Tokens.
EnableEntraIdSigningKeyCloudInstanceValidation(TokenValidationParameters)	Aktiviert die Überprüfung der Cloudinstanz der Microsoft Entra ID Tokensignaturschlüssel.

Gilt für:

Feedback

War diese Seite hilfreich?