JwtSecurityTokenHandler Classe

Definição

public class JwtSecurityTokenHandler : Microsoft.IdentityModel.Tokens.SecurityTokenHandler
type JwtSecurityTokenHandler = class
    inherit SecurityTokenHandler
Public Class JwtSecurityTokenHandler
Inherits SecurityTokenHandler
Herança
JwtSecurityTokenHandler

Construtores

Nome Description
JwtSecurityTokenHandler()

Inicializa uma nova instância da classe JwtSecurityTokenHandler.

Campos

Nome Description
DefaultInboundClaimFilter

Lista de filtros de tipo de declaração padrão.

DefaultInboundClaimTypeMap

Mapeamento de tipo de declaração padrão para declarações de entrada.

DefaultMapInboundClaims

Valor padrão para o sinalizador que determina se o InboundClaimTypeMap é usado ou não.

DefaultOutboundAlgorithmMap

Mapeamento de algoritmo padrão do JwtHeader

DefaultOutboundClaimTypeMap

Mapeamento de tipo de declaração padrão para declarações de saída.

Propriedades

Nome Description
CanValidateToken

Retorna um valor que indica se esse manipulador pode validar um SecurityToken.

CanWriteToken

Obtém o valor que indica se essa instância pode gravar um SecurityToken.

InboundClaimFilter

Obtém ou define o ISet<T> usado para filtrar declarações ao preencher um ClaimsIdentity formulário de declarações.JwtSecurityToken Quando uma JwtSecurityToken é validada, as declarações com tipos encontrados neste ISet<T> não serão adicionadas ao ClaimsIdentity.

O valor padrão é ClaimTypeMapping.InboundClaimFilter.

InboundClaimTypeMap

Obtém ou define o InboundClaimTypeMap que é usado ao definir as Type declarações no ClaimsPrincipal extraído ao validar um JwtSecurityToken.

Ele Type é definido como o 'nome' da declaração JSON depois de traduzir usando esse mapeamento.

O valor padrão é ClaimTypeMapping.InboundClaimTypeMap.

JsonClaimTypeProperty

Obtém ou define o nome da propriedade do Properties tipo .Net que foi reconhecido quando Claims serializado o valor para JSON.

Consulte <seealso cref="P:System.IdentityModel.Tokens.Jwt.JwtSecurityTokenHandler.InboundClaimTypeMap"></seealso> para obter mais informações.

MapInboundClaims

Obtém ou define a MapInboundClaims propriedade que é usada ao determinar se os tipos de declaração são extraídos ou não ao validar um JwtSecurityToken.

Se isso for definido como true, ele Type será definido como o 'nome' da declaração JSON depois de traduzir usando esse mapeamento. Caso contrário, nenhum mapeamento ocorrerá.

O valor padrão é true.

MaximumTokenSizeInBytes

Obtém e define o tamanho máximo do token em bytes que serão processados.

(Herdado de TokenHandler)
OutboundAlgorithmMap

Obtém o mapa de algoritmo de saída que é passado para o JwtHeader construtor.

OutboundClaimTypeMap

Obtém ou define o OutboundClaimTypeMap que é usado ao criar um JwtSecurityToken de Claim(s).

O valor 'name' da declaração JSON é definido Type para depois de traduzir usando esse mapeamento.

O valor padrão é ClaimTypeMapping.OutboundClaimTypeMap

SetDefaultTimesOnTokenCreation

Obtém ou define um bool que controla se a criação de token definirá o padrão 'exp', 'nbf' e 'iat' se não for especificado.

(Herdado de TokenHandler)
ShortClaimTypeProperty

Obtém ou define o nome da propriedade da Properties declaração JSON original 'name' se um mapeamento ocorreu quando o Claim(s) foi criado.

Consulte <seealso cref="P:System.IdentityModel.Tokens.Jwt.JwtSecurityTokenHandler.InboundClaimTypeMap"></seealso> para obter mais informações.

TokenLifetimeInMinutes

Obtém ou define o tempo de vida do token em minutos.

(Herdado de TokenHandler)
TokenType

Obtém o tipo do JwtSecurityToken.

Métodos

Nome Description
CanReadToken(String)

Determina se a cadeia de caracteres é um JWT (Token Web Json) bem formado.

Confira: https://datatracker.ietf.org/doc/html/rfc7519

CanReadToken(XmlReader)

Indica se o XmlReader elemento está posicionado em um elemento que pode ser lido.

(Herdado de SecurityTokenHandler)
CreateActorValue(ClaimsIdentity)

Cria o 'valor' para a declaração do ator: { actort, 'value' }

CreateClaimsIdentity(JwtSecurityToken, String, TokenValidationParameters)

Cria um ClaimsIdentity de um JwtSecurityToken.

CreateEncodedJwt(SecurityTokenDescriptor)

Retorna um JWT (Token Web Json).

CreateEncodedJwt(String, String, ClaimsIdentity, Nullable<DateTime>, Nullable<DateTime>, Nullable<DateTime>, SigningCredentials, EncryptingCredentials, IDictionary<String,Object>)

Cria um JWT em 'Formato de Serialização Compacta'.

CreateEncodedJwt(String, String, ClaimsIdentity, Nullable<DateTime>, Nullable<DateTime>, Nullable<DateTime>, SigningCredentials, EncryptingCredentials)

Cria um JWT em 'Formato de Serialização Compacta'.

CreateEncodedJwt(String, String, ClaimsIdentity, Nullable<DateTime>, Nullable<DateTime>, Nullable<DateTime>, SigningCredentials)

Cria um JWT em 'Formato de Serialização Compacta'.

CreateJwtSecurityToken(SecurityTokenDescriptor)

Cria um JWT (Token Web Json).

CreateJwtSecurityToken(String, String, ClaimsIdentity, Nullable<DateTime>, Nullable<DateTime>, Nullable<DateTime>, SigningCredentials, EncryptingCredentials, IDictionary<String,Object>)

Cria um JwtSecurityToken

CreateJwtSecurityToken(String, String, ClaimsIdentity, Nullable<DateTime>, Nullable<DateTime>, Nullable<DateTime>, SigningCredentials, EncryptingCredentials)

Cria um JwtSecurityToken

CreateJwtSecurityToken(String, String, ClaimsIdentity, Nullable<DateTime>, Nullable<DateTime>, Nullable<DateTime>, SigningCredentials)

Cria um JwtSecurityToken

CreateSecurityTokenReference(SecurityToken, Boolean)

Retorna SecurityKeyIdentifierClause.

(Herdado de SecurityTokenHandler)
CreateToken(SecurityTokenDescriptor)

Cria um JWT (Token Web Json).

DecryptToken(JwtSecurityToken, TokenValidationParameters)

Descriptografa um JWE e retorna o texto claro

ReadJwtToken(String)

Converte uma cadeia de caracteres em uma instância de JwtSecurityToken.

ReadToken(String)

Converte uma cadeia de caracteres em uma instância de JwtSecurityToken.

ReadToken(XmlReader, TokenValidationParameters)

Desserializa o token com o fornecido TokenValidationParameters.

ReadToken(XmlReader)

Obtém o token de segurança.

(Herdado de SecurityTokenHandler)
ResolveIssuerSigningKey(String, JwtSecurityToken, TokenValidationParameters)

Retorna um SecurityKey a ser usado ao validar a assinatura de um token.

ResolveTokenDecryptionKey(String, JwtSecurityToken, TokenValidationParameters)

Retorna um SecurityKey a ser usado ao descriptografar um JWE.

ValidateAudience(IEnumerable<String>, JwtSecurityToken, TokenValidationParameters)

Determina se as audiências encontradas em um JwtSecurityToken são válidas.

ValidateIssuer(String, JwtSecurityToken, TokenValidationParameters)

Determina se o emissor encontrado em um JwtSecurityToken é válido.

ValidateIssuerSecurityKey(SecurityKey, JwtSecurityToken, TokenValidationParameters)

Valida o SigningKey valor esperado.

ValidateLifetime(Nullable<DateTime>, Nullable<DateTime>, JwtSecurityToken, TokenValidationParameters)

Valida o tempo de vida de um JwtSecurityToken.

ValidateSignature(String, TokenValidationParameters)

Valida se a assinatura, se encontrada ou necessária, é válida.

ValidateToken(String, TokenValidationParameters, SecurityToken)

Lê e valida um JWT (Token Web JSON) codificado como um JWS ou JWE no Formato Serializado Compacto.

ValidateToken(XmlReader, TokenValidationParameters, SecurityToken)

Lê e valida um token usando um xmlReader e TokenValidationParameters

(Herdado de SecurityTokenHandler)
ValidateTokenAsync(SecurityToken, TokenValidationParameters)

Valida um token. Em uma falha de validação, nenhuma exceção será gerada; Em vez disso, a exceção será definida na propriedade TokenValidationResult.Exception retornada. Os chamadores sempre devem verificar a propriedade TokenValidationResult.IsValid para verificar a validade do resultado.

(Herdado de TokenHandler)
ValidateTokenAsync(String, TokenValidationParameters)

Valida um token. Em uma falha de validação, nenhuma exceção será gerada; Em vez disso, a exceção será definida na propriedade TokenValidationResult.Exception retornada. Os chamadores sempre devem verificar a propriedade TokenValidationResult.IsValid para verificar a validade do resultado.

ValidateTokenPayload(JwtSecurityToken, TokenValidationParameters)

Valida o conteúdo JSON de um JwtSecurityToken.

ValidateTokenReplay(Nullable<DateTime>, String, TokenValidationParameters)

Determina se um JwtSecurityToken já está validado.

WriteToken(SecurityToken)

Serializa um JwtSecurityToken em um JWT no Formato de Serialização Compacta.

WriteToken(XmlWriter, SecurityToken)

Serializa para XML um token do tipo manipulado por essa instância.

Aplica-se a