JsonWebTokenHandler Klasa

Definicja

Przestrzeń nazw:: Microsoft.IdentityModel.JsonWebTokens

Zestaw:: Microsoft.IdentityModel.JsonWebTokens.dll

Pakiet:: Microsoft.IdentityModel.JsonWebTokens v8.19.1

Ważne

Niektóre informacje odnoszą się do produktu w wersji wstępnej, który może zostać znacząco zmodyfikowany przed wydaniem. Firma Microsoft nie udziela żadnych gwarancji, jawnych lub domniemanych, w odniesieniu do informacji podanych w tym miejscu.

Obiekt SecurityTokenHandler przeznaczony do tworzenia i weryfikowania tokenów sieci Web Json. Zobacz: https://datatracker.ietf.org/doc/html/rfc7519 i http://www.rfc-editor.org/info/rfc7515.

public class JsonWebTokenHandler : Microsoft.IdentityModel.Tokens.TokenHandler, Microsoft.IdentityModel.Tokens.Experimental.IResultBasedValidation

type JsonWebTokenHandler = class
    inherit TokenHandler
    interface IResultBasedValidation

Public Class JsonWebTokenHandler
Inherits TokenHandler
Implements IResultBasedValidation

Dziedziczenie: Object

TokenHandler
JsonWebTokenHandler

Implementuje: IResultBasedValidation

Uwagi

Ta klasa częściowa zawiera metody i logikę związaną z walidacją tokenów.

Konstruktory

Nazwa	Opis
JsonWebTokenHandler()	Inicjuje nowe wystąpienie klasy JsonWebTokenHandler.

Pola

Nazwa	Opis
Base64UrlEncodedUnsignedJWSHeader	Pobiera reprezentację ciągu zakodowanego w formacie Base64Url następującego nagłówka JWT: { Alg, None }.
DefaultInboundClaimTypeMap	Domyślne mapowanie typu oświadczenia dla oświadczeń przychodzących.
DefaultMapInboundClaims	Wartość domyślna flagi, która określa, czy jest używana wartość InboundClaimTypeMap.

Właściwości

Nazwa	Opis
CanValidateToken	Zwraca wartość wskazującą, czy ta procedura obsługi może zweryfikować SecurityTokenelement .
InboundClaimTypeMap	Pobiera lub ustawia InboundClaimTypeMap wartość, która jest używana podczas ustawiania Type dla oświadczeń w ClaimsPrincipal wyodrębnionym podczas sprawdzania poprawności elementu JsonWebToken. Właściwość jest ustawiona Type na oświadczenie JSON "name" po przetłumaczeniu przy użyciu tego mapowania. Wartość domyślna to ClaimTypeMapping.InboundClaimTypeMap.
MapInboundClaims	Pobiera lub ustawia MapInboundClaims właściwość, która jest używana podczas określania, czy mapować typy oświadczeń, które są wyodrębniane podczas walidacji JsonWebTokenelementu . Jeśli ta wartość ma wartość true, Type parametr jest ustawiony na oświadczenie JSON "name" po przetłumaczeniu przy użyciu tego mapowania. W przeciwnym razie nie ma mapowania. Wartość domyślna to fałsz.
MaximumTokenSizeInBytes	Pobiera i ustawia maksymalny rozmiar tokenu w bajtach, które zostaną przetworzone. (Odziedziczone po TokenHandler)
SetDefaultTimesOnTokenCreation	Pobiera lub ustawia wartość logiczną, która kontroluje, czy tworzenie tokenu ustawi domyślne wyrażenie "exp", "nbf" i "iat", jeśli nie zostanie określone. (Odziedziczone po TokenHandler)
ShortClaimTypeProperty	Pobiera lub ustawia nazwę Properties właściwości obiektu będzie zawierać oryginalne oświadczenie JSON "name", jeśli podczas tworzenia (s) wystąpiło mapowanie Claim.
TokenLifetimeInMinutes	Pobiera lub ustawia okres istnienia tokenu w minutach. (Odziedziczone po TokenHandler)
TokenType	Pobiera typ JsonWebToken.

Metody

Nazwa	Opis
CanReadToken(String)	Określa, czy ciąg jest dobrze sformułowanym tokenem internetowym JSON (JWT). Zobacz: https://datatracker.ietf.org/doc/html/rfc7519.
CreateClaimsIdentity(JsonWebToken, TokenValidationParameters, String)	Tworzy element ClaimsIdentity z JsonWebToken określonego wystawcy.
CreateClaimsIdentity(JsonWebToken, TokenValidationParameters)	Tworzy obiekt ClaimsIdentity na podstawie elementu JsonWebToken.
CreateToken(SecurityTokenDescriptor)	Tworzy zestaw JWT, który może być zestawem JWS lub JWE.
CreateToken(String, EncryptingCredentials, IDictionary<String,Object>)	Tworzy szyfrowanie JSON Web Encryption (JWE).
CreateToken(String, EncryptingCredentials, String)	Tworzy szyfrowanie JSON Web Encryption (JWE).
CreateToken(String, EncryptingCredentials)	Tworzy szyfrowanie JSON Web Encryption (JWE).
CreateToken(String, IDictionary<String,Object>)	Tworzy niepodpisany podpis internetowy JSON (JWS).
CreateToken(String, SigningCredentials, EncryptingCredentials, IDictionary<String,Object>)	Tworzy szyfrowanie JSON Web Encryption (JWE).
CreateToken(String, SigningCredentials, EncryptingCredentials, String, IDictionary<String,Object>, IDictionary<String,Object>)	Tworzy szyfrowanie JSON Web Encryption (JWE).
CreateToken(String, SigningCredentials, EncryptingCredentials, String, IDictionary<String,Object>)	Tworzy szyfrowanie JSON Web Encryption (JWE).
CreateToken(String, SigningCredentials, EncryptingCredentials, String)	Tworzy szyfrowanie JSON Web Encryption (JWE).
CreateToken(String, SigningCredentials, EncryptingCredentials)	Tworzy szyfrowanie JSON Web Encryption (JWE).
CreateToken(String, SigningCredentials, IDictionary<String,Object>)	Tworzy sygnaturę internetową JSON (JWS).
CreateToken(String, SigningCredentials)	Tworzy sygnaturę internetową JSON (JWS).
CreateToken(String)	Tworzy niepodpisany podpis internetowy JSON (JWS).
DecryptToken(JsonWebToken, TokenValidationParameters)	Odszyfrowuje JWE i zwraca zwykły tekst.
DecryptTokenWithConfigurationAsync(JsonWebToken, TokenValidationParameters, CancellationToken)	Odszyfrowuje JWE i zwraca zwykły tekst.
EncryptToken(String, EncryptingCredentials, IDictionary<String,Object>)	Szyfruje zestaw JWS.
EncryptToken(String, EncryptingCredentials, String, IDictionary<String,Object>)	Szyfruje zestaw JWS.
EncryptToken(String, EncryptingCredentials, String)	Szyfruje zestaw JWS.
EncryptToken(String, EncryptingCredentials)	Szyfruje zestaw JWS.
ReadJsonWebToken(ReadOnlyMemory<Char>)	Konwertuje zakres znaków ReadOnlyMemory na wystąpienie JsonWebTokenklasy .
ReadJsonWebToken(String)	Konwertuje ciąg na wystąpienie JsonWebTokenklasy .
ReadToken(String)	Konwertuje ciąg na wystąpienie JsonWebTokenklasy .
ResolveTokenDecryptionKey(String, JsonWebToken, TokenValidationParameters)	Zwraca wartość SecurityKey do użycia podczas odszyfrowywania JWE.
ValidateToken(String, TokenValidationParameters)	Przestarzałe. Weryfikuje zestaw JWS lub JWE.
ValidateTokenAsync(SecurityToken, TokenValidationParameters)	Weryfikuje token. W przypadku niepowodzenia walidacji nie zostanie zgłoszony żaden wyjątek; Zamiast tego wyjątek zostanie ustawiony we zwróconej właściwości TokenValidationResult.Exception. Osoby wywołujące powinny zawsze sprawdzać właściwość TokenValidationResult.IsValid, aby sprawdzić poprawność wyniku.
ValidateTokenAsync(String, TokenValidationParameters)	Weryfikuje token. W przypadku niepowodzenia walidacji nie zostanie zgłoszony żaden wyjątek; Zamiast tego wyjątek zostanie ustawiony we zwróconej właściwości TokenValidationResult.Exception. Osoby wywołujące powinny zawsze sprawdzać właściwość TokenValidationResult.IsValid, aby sprawdzić poprawność wyniku.

Jawne implementacje interfejsu

Nazwa	Opis
IResultBasedValidation.ValidateTokenAsync(SecurityToken, ValidationParameters, CallContext, CancellationToken)	Obiekt SecurityTokenHandler przeznaczony do tworzenia i weryfikowania tokenów sieci Web Json. Zobacz: https://datatracker.ietf.org/doc/html/rfc7519 i http://www.rfc-editor.org/info/rfc7515.
IResultBasedValidation.ValidateTokenAsync(SecurityToken, ValidationParameters, CallContext)	Obiekt SecurityTokenHandler przeznaczony do tworzenia i weryfikowania tokenów sieci Web Json. Zobacz: https://datatracker.ietf.org/doc/html/rfc7519 i http://www.rfc-editor.org/info/rfc7515.
IResultBasedValidation.ValidateTokenAsync(String, ValidationParameters, CallContext, CancellationToken)	Obiekt SecurityTokenHandler przeznaczony do tworzenia i weryfikowania tokenów sieci Web Json. Zobacz: https://datatracker.ietf.org/doc/html/rfc7519 i http://www.rfc-editor.org/info/rfc7515.
IResultBasedValidation.ValidateTokenAsync(String, ValidationParameters, CallContext)	Obiekt SecurityTokenHandler przeznaczony do tworzenia i weryfikowania tokenów sieci Web Json. Zobacz: https://datatracker.ietf.org/doc/html/rfc7519 i http://www.rfc-editor.org/info/rfc7515.

Dotyczy

Opinia

Czy ta strona była pomocna?