JwtSecurityTokenHandler Klasse

Definition

Namespace:: System.IdentityModel.Tokens.Jwt

Assembly:: System.IdentityModel.Tokens.Jwt.dll

Paket:: System.IdentityModel.Tokens.Jwt 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.

Ein SecurityTokenHandler Design zum Erstellen und Validieren von JSON-Webtoken. Siehe: https://datatracker.ietf.org/doc/html/rfc7519 und http://www.rfc-editor.org/info/rfc7515

public class JwtSecurityTokenHandler : Microsoft.IdentityModel.Tokens.SecurityTokenHandler

type JwtSecurityTokenHandler = class
    inherit SecurityTokenHandler

Public Class JwtSecurityTokenHandler
Inherits SecurityTokenHandler

Vererbung: Object

TokenHandler

SecurityTokenHandler
JwtSecurityTokenHandler

Konstruktoren

Name	Beschreibung
JwtSecurityTokenHandler()	Initialisiert eine neue Instanz der JwtSecurityTokenHandler-Klasse.

Felder

Name	Beschreibung
DefaultInboundClaimFilter	Standardfilterliste für Anspruchstypen.
DefaultInboundClaimTypeMap	Standardanspruchstypzuordnung für eingehende Ansprüche.
DefaultMapInboundClaims	Standardwert für das Flag, das bestimmt, ob die InboundClaimTypeMap verwendet wird.
DefaultOutboundAlgorithmMap	Standardmäßige JwtHeader-Algorithmuszuordnung
DefaultOutboundClaimTypeMap	Standardanspruchstypzuordnung für ausgehende Ansprüche.

Eigenschaften

Name	Beschreibung
CanValidateToken	Gibt einen Wert zurück, der angibt, ob dieser Handler eine SecurityToken.
CanWriteToken	Ruft den Wert ab, der angibt, ob diese Instanz eine SecurityToken.
InboundClaimFilter	Dient zum Abrufen oder Festlegen der ISet<T> verwendung zum Filtern von Ansprüchen beim Auffüllen eines Anspruchsformulars ClaimsIdentity einer JwtSecurityToken. Wenn eine JwtSecurityToken Überprüfung erfolgt, werden Ansprüche mit typen, die darin ISet<T> enthalten sind, nicht dem ClaimsIdentityHinzugefügt. Der Standardwert ist "ClaimTypeMapping.InboundClaimFilter".
InboundClaimTypeMap	Dient zum Abrufen oder Festlegen des Werts, der InboundClaimTypeMap beim Festlegen der Type für Ansprüche im ClaimsPrincipal extrahierten Bereich beim Validieren einer JwtSecurityToken. Der Type Name wird nach der Übersetzung mithilfe dieser Zuordnung auf den JSON-Anspruch "name" festgelegt. Der Standardwert ist "ClaimTypeMapping.InboundClaimTypeMap".
JsonClaimTypeProperty	Dient zum Abrufen oder Festlegen des Eigenschaftennamens des Properties Typs .Net, der beim Claims Serialisieren des Werts in JSON erkannt wurde. Weitere Informationen finden Sie <unter seealso cref="P:System.IdentityModel.Tokens.Jwt.JwtSecurityTokenHandler.InboundClaimTypeMap"></seealso> .
MapInboundClaims	Dient zum Abrufen oder Festlegen der MapInboundClaims Eigenschaft, die verwendet wird, wenn bestimmt wird, ob Anspruchstypen zugeordnet werden sollen, die beim Überprüfen einer JwtSecurityTokenextrahiert werden. Wenn dies auf "true" festgelegt ist, wird der Type JSON-Anspruch "name" nach der Übersetzung mithilfe dieser Zuordnung festgelegt. Andernfalls tritt keine Zuordnung auf. Der Standardwert lautet „true“.
MaximumTokenSizeInBytes	Ruft die maximale Tokengröße in Bytes ab, die verarbeitet werden, und legt diese fest. (Geerbt von TokenHandler)
OutboundAlgorithmMap	Ruft die ausgehende Algorithmuszuordnung ab, die an den JwtHeader Konstruktor übergeben wird.
OutboundClaimTypeMap	Ruft ab oder legt fest, OutboundClaimTypeMap welche beim Erstellen einer JwtSecurityToken von Claim(s) verwendet wird. Der JSON-Anspruchswert "name" wird nach der Übersetzung mithilfe dieser Zuordnung festgelegt Type . Der Standardwert ist "ClaimTypeMapping.OutboundClaimTypeMap".
SetDefaultTimesOnTokenCreation	Dient zum Abrufen oder Festlegen eines Bools, das steuert, ob die Tokenerstellung den Standardwert "exp", "nbf" und "iat" festlegt, falls nicht angegeben. (Geerbt von TokenHandler)
ShortClaimTypeProperty	Dient zum Abrufen oder Festlegen des Eigenschaftennamens des Properties Objekts, der den ursprünglichen JSON-Anspruch "name" enthält, wenn eine Zuordnung aufgetreten ist, wenn die Claim(s) erstellt wurden. Weitere Informationen finden Sie <unter seealso cref="P:System.IdentityModel.Tokens.Jwt.JwtSecurityTokenHandler.InboundClaimTypeMap"></seealso> .
TokenLifetimeInMinutes	Ruft die Tokenlebensdauer in Minuten ab oder legt sie fest. (Geerbt von TokenHandler)
TokenType	Ruft den Typ des JwtSecurityTokenab.

Methoden

Name	Beschreibung
CanReadToken(String)	Bestimmt, ob die Zeichenfolge ein wohlgeformtes JSON-Webtoken (JWT) ist. Siehe: https://datatracker.ietf.org/doc/html/rfc7519
CanReadToken(XmlReader)	Gibt an, ob die XmlReader Position an einem Element liegt, das gelesen werden kann. (Geerbt von SecurityTokenHandler)
CreateActorValue(ClaimsIdentity)	Erstellt den Wert für den Akteuranspruch: { actort, 'value' }
CreateClaimsIdentity(JwtSecurityToken, String, TokenValidationParameters)	Erstellt ein ClaimsIdentity Aus einem JwtSecurityToken.
CreateEncodedJwt(SecurityTokenDescriptor)	Gibt ein JSON-Webtoken (JWT) zurück.
CreateEncodedJwt(String, String, ClaimsIdentity, Nullable<DateTime>, Nullable<DateTime>, Nullable<DateTime>, SigningCredentials, EncryptingCredentials, IDictionary<String,Object>)	Erstellt ein JWT im "Compact Serialization Format".
CreateEncodedJwt(String, String, ClaimsIdentity, Nullable<DateTime>, Nullable<DateTime>, Nullable<DateTime>, SigningCredentials, EncryptingCredentials)	Erstellt ein JWT im "Compact Serialization Format".
CreateEncodedJwt(String, String, ClaimsIdentity, Nullable<DateTime>, Nullable<DateTime>, Nullable<DateTime>, SigningCredentials)	Erstellt ein JWT im "Compact Serialization Format".
CreateJwtSecurityToken(SecurityTokenDescriptor)	Erstellt ein JSON-Webtoken (JWT).
CreateJwtSecurityToken(String, String, ClaimsIdentity, Nullable<DateTime>, Nullable<DateTime>, Nullable<DateTime>, SigningCredentials, EncryptingCredentials, IDictionary<String,Object>)	Erstellt eine JwtSecurityToken
CreateJwtSecurityToken(String, String, ClaimsIdentity, Nullable<DateTime>, Nullable<DateTime>, Nullable<DateTime>, SigningCredentials, EncryptingCredentials)	Erstellt eine JwtSecurityToken
CreateJwtSecurityToken(String, String, ClaimsIdentity, Nullable<DateTime>, Nullable<DateTime>, Nullable<DateTime>, SigningCredentials)	Erstellt eine JwtSecurityToken
CreateSecurityTokenReference(SecurityToken, Boolean)	Gibt SecurityKeyIdentifierClause zurück. (Geerbt von SecurityTokenHandler)
CreateToken(SecurityTokenDescriptor)	Erstellt ein JSON-Webtoken (JWT).
DecryptToken(JwtSecurityToken, TokenValidationParameters)	Entschlüsselt ein JWE und gibt den Klartext zurück.
ReadJwtToken(String)	Konvertiert eine Zeichenfolge in eine Instanz von JwtSecurityToken.
ReadToken(String)	Konvertiert eine Zeichenfolge in eine Instanz von JwtSecurityToken.
ReadToken(XmlReader, TokenValidationParameters)	Deserialisiert das Token mit dem bereitgestellten TokenValidationParameters.
ReadToken(XmlReader)	Ruft Sicherheitstoken ab. (Geerbt von SecurityTokenHandler)
ResolveIssuerSigningKey(String, JwtSecurityToken, TokenValidationParameters)	Gibt einen SecurityKey Wert zurück, der beim Überprüfen der Signatur eines Tokens verwendet werden soll.
ResolveTokenDecryptionKey(String, JwtSecurityToken, TokenValidationParameters)	Gibt einen SecurityKey Wert zurück, der beim Entschlüsseln eines JWE verwendet werden soll.
ValidateAudience(IEnumerable<String>, JwtSecurityToken, TokenValidationParameters)	Bestimmt, ob die in einer JwtSecurityToken gruppe gefundenen Benutzergruppen gültig sind.
ValidateIssuer(String, JwtSecurityToken, TokenValidationParameters)	Bestimmt, ob der in einer JwtSecurityToken Emittente gefundene gültig ist.
ValidateIssuerSecurityKey(SecurityKey, JwtSecurityToken, TokenValidationParameters)	Überprüft, ob es SigningKey sich um einen erwarteten Wert handelt.
ValidateLifetime(Nullable<DateTime>, Nullable<DateTime>, JwtSecurityToken, TokenValidationParameters)	Überprüft die Lebensdauer eines .JwtSecurityToken
ValidateSignature(String, TokenValidationParameters)	Überprüft, ob die Signatur gültig ist, falls gefunden oder erforderlich.
ValidateToken(String, TokenValidationParameters, SecurityToken)	Liest und überprüft ein "JSON Web Token" (JWT) codiert als JWS oder JWE im komprimierten serialisierten Format.
ValidateToken(XmlReader, TokenValidationParameters, SecurityToken)	Liest und überprüft ein Token mithilfe eines xmlReader und TokenValidationParameters (Geerbt von SecurityTokenHandler)
ValidateTokenAsync(SecurityToken, TokenValidationParameters)	Überprüft ein Token. Bei einem Überprüfungsfehler wird keine Ausnahme ausgelöst. Stattdessen wird die Ausnahme in der zurückgegebenen TokenValidationResult.Exception-Eigenschaft festgelegt. Aufrufer sollten immer die TokenValidationResult.IsValid-Eigenschaft überprüfen, um die Gültigkeit des Ergebnisses zu überprüfen. (Geerbt von TokenHandler)
ValidateTokenAsync(String, TokenValidationParameters)	Überprüft ein Token. Bei einem Überprüfungsfehler wird keine Ausnahme ausgelöst. Stattdessen wird die Ausnahme in der zurückgegebenen TokenValidationResult.Exception-Eigenschaft festgelegt. Aufrufer sollten immer die TokenValidationResult.IsValid-Eigenschaft überprüfen, um die Gültigkeit des Ergebnisses zu überprüfen.
ValidateTokenPayload(JwtSecurityToken, TokenValidationParameters)	Überprüft die JSON-Nutzlast eines JwtSecurityToken.
ValidateTokenReplay(Nullable<DateTime>, String, TokenValidationParameters)	Bestimmt, ob bereits eine JwtSecurityToken Überprüfung erfolgt.
WriteToken(SecurityToken)	Serialisiert eine JwtSecurityToken in ein JWT im kompakten Serialisierungsformat.
WriteToken(XmlWriter, SecurityToken)	Serialisiert in XML ein Token des Typs, der von dieser Instanz behandelt wird.

Gilt für:

Feedback

War diese Seite hilfreich?