JsonWebTokenHandler Klasse
Definition
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 JsonWebTokenHandler : Microsoft.IdentityModel.Tokens.TokenHandler, Microsoft.IdentityModel.Tokens.Experimental.IResultBasedValidationtype JsonWebTokenHandler = class
inherit TokenHandler
interface IResultBasedValidationPublic Class JsonWebTokenHandler
Inherits TokenHandler
Implements IResultBasedValidation- Vererbung
- Implementiert
Hinweise
Diese partielle Klasse enthält Methoden und Logik im Zusammenhang mit der Überprüfung von Token.
Konstruktoren
| Name | Beschreibung |
|---|---|
| JsonWebTokenHandler() |
Initialisiert eine neue Instanz der JsonWebTokenHandler-Klasse. |
Felder
| Name | Beschreibung |
|---|---|
| Base64UrlEncodedUnsignedJWSHeader |
Ruft die Base64Url-codierte Zeichenfolgendarstellung des folgenden JWT-Headers ab: { Alg, None }. |
| DefaultInboundClaimTypeMap |
Standardanspruchstypzuordnung für eingehende Ansprüche. |
| DefaultMapInboundClaims |
Standardwert für das Flag, das bestimmt, ob die InboundClaimTypeMap verwendet wird. |
Eigenschaften
| Name | Beschreibung |
|---|---|
| CanValidateToken |
Gibt einen Wert zurück, der angibt, ob dieser Handler eine SecurityToken. |
| 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 JsonWebToken. Der Type Name wird nach der Übersetzung mithilfe dieser Zuordnung auf den JSON-Anspruch "name" festgelegt. Der Standardwert ist "ClaimTypeMapping.InboundClaimTypeMap". |
| 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 JsonWebTokenextrahiert 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 ist "false". |
| MaximumTokenSizeInBytes |
Ruft die maximale Tokengröße in Bytes ab, die verarbeitet werden, und legt diese fest. (Geerbt von TokenHandler) |
| 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. |
| TokenLifetimeInMinutes |
Ruft die Tokenlebensdauer in Minuten ab oder legt sie fest. (Geerbt von TokenHandler) |
| TokenType |
Ruft den Typ des JsonWebTokenab. |
Methoden
| Name | Beschreibung |
|---|---|
| CanReadToken(String) |
Bestimmt, ob es sich bei der Zeichenfolge um ein wohlgeformtes JSON-Webtoken (JWT) handelt. Siehe: https://datatracker.ietf.org/doc/html/rfc7519. |
| CreateClaimsIdentity(JsonWebToken, TokenValidationParameters, String) |
Erstellt eine ClaimsIdentity aus einem JsonWebToken mit dem angegebenen Aussteller. |
| CreateClaimsIdentity(JsonWebToken, TokenValidationParameters) |
Erstellt ein ClaimsIdentity Aus einem JsonWebToken. |
| CreateToken(SecurityTokenDescriptor) |
Erstellt einen JWT, der ein JWS oder JWE sein kann. |
| CreateToken(String, EncryptingCredentials, IDictionary<String,Object>) |
Erstellt eine JSON-Webverschlüsselung (JWE). |
| CreateToken(String, EncryptingCredentials, String) |
Erstellt eine JSON-Webverschlüsselung (JWE). |
| CreateToken(String, EncryptingCredentials) |
Erstellt eine JSON-Webverschlüsselung (JWE). |
| CreateToken(String, IDictionary<String,Object>) |
Erstellt eine nicht signierte JSON-Websignatur (JWS). |
| CreateToken(String, SigningCredentials, EncryptingCredentials, IDictionary<String,Object>) |
Erstellt eine JSON-Webverschlüsselung (JWE). |
| CreateToken(String, SigningCredentials, EncryptingCredentials, String, IDictionary<String,Object>, IDictionary<String,Object>) |
Erstellt eine JSON-Webverschlüsselung (JWE). |
| CreateToken(String, SigningCredentials, EncryptingCredentials, String, IDictionary<String,Object>) |
Erstellt eine JSON-Webverschlüsselung (JWE). |
| CreateToken(String, SigningCredentials, EncryptingCredentials, String) |
Erstellt eine JSON-Webverschlüsselung (JWE). |
| CreateToken(String, SigningCredentials, EncryptingCredentials) |
Erstellt eine JSON-Webverschlüsselung (JWE). |
| CreateToken(String, SigningCredentials, IDictionary<String,Object>) |
Erstellt eine JSON-Websignatur (JWS). |
| CreateToken(String, SigningCredentials) |
Erstellt eine JSON-Websignatur (JWS). |
| CreateToken(String) |
Erstellt eine nicht signierte JSON-Websignatur (JWS). |
| DecryptToken(JsonWebToken, TokenValidationParameters) |
Entschlüsselt ein JWE und gibt den Klartext zurück. |
| DecryptTokenWithConfigurationAsync(JsonWebToken, TokenValidationParameters, CancellationToken) |
Entschlüsselt ein JWE und gibt den Klartext zurück. |
| EncryptToken(String, EncryptingCredentials, IDictionary<String,Object>) |
Verschlüsselt ein JWS. |
| EncryptToken(String, EncryptingCredentials, String, IDictionary<String,Object>) |
Verschlüsselt ein JWS. |
| EncryptToken(String, EncryptingCredentials, String) |
Verschlüsselt ein JWS. |
| EncryptToken(String, EncryptingCredentials) |
Verschlüsselt ein JWS. |
| ReadJsonWebToken(ReadOnlyMemory<Char>) |
Wandelt eine ReadOnlyMemory-Spanne von Zeichen in eine Instanz von JsonWebToken. |
| ReadJsonWebToken(String) |
Konvertiert eine Zeichenfolge in eine Instanz von JsonWebToken. |
| ReadToken(String) |
Konvertiert eine Zeichenfolge in eine Instanz von JsonWebToken. |
| ResolveTokenDecryptionKey(String, JsonWebToken, TokenValidationParameters) |
Gibt einen SecurityKey Wert zurück, der beim Entschlüsseln eines JWE verwendet werden soll. |
| ValidateToken(String, TokenValidationParameters) |
Veraltet.
Überprüft ein JWS oder ein JWE. |
| 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. |
| 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. |