JwtSecurityTokenHandler Klasa

Definicja

Przestrzeń nazw:: System.IdentityModel.Tokens.Jwt

Zestaw:: System.IdentityModel.Tokens.Jwt.dll

Pakiet:: System.IdentityModel.Tokens.Jwt 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 JwtSecurityTokenHandler : Microsoft.IdentityModel.Tokens.SecurityTokenHandler

type JwtSecurityTokenHandler = class
    inherit SecurityTokenHandler

Public Class JwtSecurityTokenHandler
Inherits SecurityTokenHandler

Dziedziczenie: Object

TokenHandler

SecurityTokenHandler
JwtSecurityTokenHandler

Konstruktory

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

Pola

Nazwa	Opis
DefaultInboundClaimFilter	Domyślna lista filtrów typów oświadczeń.
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.
DefaultOutboundAlgorithmMap	Domyślne mapowanie algorytmu JwtHeader
DefaultOutboundClaimTypeMap	Domyślne mapowanie typu oświadczenia dla oświadczeń wychodzących.

Właściwości

Nazwa	Opis
CanValidateToken	Zwraca wartość wskazującą, czy ta procedura obsługi może zweryfikować SecurityTokenelement .
CanWriteToken	Pobiera wartość wskazującą SecurityToken, czy to wystąpienie może zapisać element .
InboundClaimFilter	Pobiera lub ustawia ISet<T> używane do filtrowania oświadczeń podczas wypełniania ClaimsIdentity oświadczeń w formie JwtSecurityToken. Gdy element zostanie zweryfikowany, oświadczenia z typami znalezionymi w tym elemecie JwtSecurityToken nie zostaną dodane do elementu ClaimsIdentity.ISet<T> Wartość domyślna to ClaimTypeMapping.InboundClaimFilter.
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 JwtSecurityToken. 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.
JsonClaimTypeProperty	Pobiera lub ustawia nazwę Properties właściwości obiektu będzie zawierać typ platformy .Net, który został rozpoznany podczas Claims serializacji wartości do formatu JSON. Aby uzyskać więcej informacji, zobacz <seealso cref="P:System.IdentityModel.Tokens.Jwt.JwtSecurityTokenHandler.InboundClaimTypeMap"></seealso> .
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 JwtSecurityTokenelementu . 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 true.
MaximumTokenSizeInBytes	Pobiera i ustawia maksymalny rozmiar tokenu w bajtach, które zostaną przetworzone. (Odziedziczone po TokenHandler)
OutboundAlgorithmMap	Pobiera mapę algorytmu ruchu wychodzącego przekazywaną do konstruktora JwtHeader .
OutboundClaimTypeMap	Pobiera lub ustawia OutboundClaimTypeMap wartość, która jest używana podczas tworzenia elementu JwtSecurityToken z Claim(s). Wartość oświadczenia JSON "name" jest ustawiona na wartość Type po przetłumaczeniu przy użyciu tego mapowania. Wartość domyślna to ClaimTypeMapping.OutboundClaimTypeMap
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. Aby uzyskać więcej informacji, zobacz <seealso cref="P:System.IdentityModel.Tokens.Jwt.JwtSecurityTokenHandler.InboundClaimTypeMap"></seealso> .
TokenLifetimeInMinutes	Pobiera lub ustawia okres istnienia tokenu w minutach. (Odziedziczone po TokenHandler)
TokenType	Pobiera typ JwtSecurityToken.

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
CanReadToken(XmlReader)	Wskazuje, czy XmlReader element jest umieszczony w elemecie, który można odczytać. (Odziedziczone po SecurityTokenHandler)
CreateActorValue(ClaimsIdentity)	Tworzy wartość dla oświadczenia aktora: { actort, 'value' }
CreateClaimsIdentity(JwtSecurityToken, String, TokenValidationParameters)	Tworzy obiekt ClaimsIdentity na podstawie elementu JwtSecurityToken.
CreateEncodedJwt(SecurityTokenDescriptor)	Zwraca token internetowy Json (JWT).
CreateEncodedJwt(String, String, ClaimsIdentity, Nullable<DateTime>, Nullable<DateTime>, Nullable<DateTime>, SigningCredentials, EncryptingCredentials, IDictionary<String,Object>)	Tworzy JWT w formacie "Compact Serialization Format".
CreateEncodedJwt(String, String, ClaimsIdentity, Nullable<DateTime>, Nullable<DateTime>, Nullable<DateTime>, SigningCredentials, EncryptingCredentials)	Tworzy JWT w formacie "Compact Serialization Format".
CreateEncodedJwt(String, String, ClaimsIdentity, Nullable<DateTime>, Nullable<DateTime>, Nullable<DateTime>, SigningCredentials)	Tworzy JWT w formacie "Compact Serialization Format".
CreateJwtSecurityToken(SecurityTokenDescriptor)	Tworzy token internetowy Json (JWT).
CreateJwtSecurityToken(String, String, ClaimsIdentity, Nullable<DateTime>, Nullable<DateTime>, Nullable<DateTime>, SigningCredentials, EncryptingCredentials, IDictionary<String,Object>)	Tworzy obiekt JwtSecurityToken
CreateJwtSecurityToken(String, String, ClaimsIdentity, Nullable<DateTime>, Nullable<DateTime>, Nullable<DateTime>, SigningCredentials, EncryptingCredentials)	Tworzy obiekt JwtSecurityToken
CreateJwtSecurityToken(String, String, ClaimsIdentity, Nullable<DateTime>, Nullable<DateTime>, Nullable<DateTime>, SigningCredentials)	Tworzy obiekt JwtSecurityToken
CreateSecurityTokenReference(SecurityToken, Boolean)	Zwraca wartość SecurityKeyIdentifierClause. (Odziedziczone po SecurityTokenHandler)
CreateToken(SecurityTokenDescriptor)	Tworzy token internetowy Json (JWT).
DecryptToken(JwtSecurityToken, TokenValidationParameters)	Odszyfrowuje JWE i zwraca zwykły tekst
ReadJwtToken(String)	Konwertuje ciąg na wystąpienie JwtSecurityTokenklasy .
ReadToken(String)	Konwertuje ciąg na wystąpienie JwtSecurityTokenklasy .
ReadToken(XmlReader, TokenValidationParameters)	Deserializuje token z podanym TokenValidationParameterselementem .
ReadToken(XmlReader)	Pobiera token zabezpieczający. (Odziedziczone po SecurityTokenHandler)
ResolveIssuerSigningKey(String, JwtSecurityToken, TokenValidationParameters)	Zwraca wartość SecurityKey , która ma być używana podczas sprawdzania poprawności podpisu tokenu.
ResolveTokenDecryptionKey(String, JwtSecurityToken, TokenValidationParameters)	Zwraca wartość do SecurityKey użycia podczas odszyfrowywania JWE.
ValidateAudience(IEnumerable<String>, JwtSecurityToken, TokenValidationParameters)	Określa, czy odbiorcy znalezioni w obiekcie JwtSecurityToken są prawidłowe.
ValidateIssuer(String, JwtSecurityToken, TokenValidationParameters)	Określa, czy wystawca znaleziony w obiekcie JwtSecurityToken jest prawidłowy.
ValidateIssuerSecurityKey(SecurityKey, JwtSecurityToken, TokenValidationParameters)	Sprawdza, czy SigningKey wartość jest oczekiwana.
ValidateLifetime(Nullable<DateTime>, Nullable<DateTime>, JwtSecurityToken, TokenValidationParameters)	Weryfikuje okres istnienia obiektu JwtSecurityToken.
ValidateSignature(String, TokenValidationParameters)	Sprawdza, czy podpis, jeśli został znaleziony lub wymagany, jest prawidłowy.
ValidateToken(String, TokenValidationParameters, SecurityToken)	Odczytuje i weryfikuje kod "JSON Web Token" (JWT) zakodowany jako JWS lub JWE w kompaktowym formacie serializowanym.
ValidateToken(XmlReader, TokenValidationParameters, SecurityToken)	Odczytuje i weryfikuje token przy użyciu elementu xmlReader i TokenValidationParameters (Odziedziczone po SecurityTokenHandler)
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. (Odziedziczone po TokenHandler)
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.
ValidateTokenPayload(JwtSecurityToken, TokenValidationParameters)	Sprawdza poprawność ładunku JSON obiektu JwtSecurityToken.
ValidateTokenReplay(Nullable<DateTime>, String, TokenValidationParameters)	Określa, czy JwtSecurityToken element jest już zweryfikowany.
WriteToken(SecurityToken)	Serializuje element JwtSecurityToken w formacie JWT w formacie serializacji kompaktowej.
WriteToken(XmlWriter, SecurityToken)	Serializuje do XML token typu obsługiwanego przez to wystąpienie.

Dotyczy

Opinia

Czy ta strona była pomocna?