Idioma

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 Descrição
JwtSecurityTokenHandler()

Inicializa uma nova instância da JwtSecurityTokenHandler classe.

Campos

Nome Descrição
DefaultInboundClaimFilter

Lista de filtros de tipos de reclamação por defeito.

DefaultInboundClaimTypeMap

Mapeamento de tipos de reclamação por defeito para reclamações recebidas.

DefaultMapInboundClaims

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

DefaultOutboundAlgorithmMap

Mapeamento padrão do algoritmo JwtHeader

DefaultOutboundClaimTypeMap

Mapeamento do tipo de reclamação por incumprimento para reclamações de saída.

Propriedades

Nome Descrição
CanValidateToken

Devolve um valor que indica se este manipulador pode validar um SecurityToken.

CanWriteToken

Obtém o valor que indica se esta instância pode escrever um SecurityToken.

InboundClaimFilter

Obtém ou define o ISet<T> usado para filtrar reivindicações ao preencher uma ClaimsIdentity forma de reivindicações .JwtSecurityToken Quando a JwtSecurityToken é validado, reivindicações com tipos encontrados em isto 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 os Type para reivindicações em o ClaimsPrincipal extraído ao validar um JwtSecurityToken.

O Type é definido para a reivindicação JSON 'name' após tradução usando esta correspondência.

O valor predefinido é ClaimTypeMapping.InboundClaimTypeMap.

JsonClaimTypeProperty

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

Veja <também cref="P:System.IdentityModel.Tokens.Jwt.JwtSecurityTokenHandler.InboundClaimTypeMap"></veja também> para mais informações.

MapInboundClaims

Obtém ou define a MapInboundClaims propriedade que é usada ao determinar se deve ou não mapear tipos de reivindicações que são extraídos ao validar um JwtSecurityToken.

Se isto for definido como verdadeiro, o Type é definido para a reivindicação JSON 'name' após traduzir usando este mapeamento. Caso contrário, não ocorre mapeamento.

O valor predefinido é 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 do algoritmo de saída que é passado ao JwtHeader construtor.

OutboundClaimTypeMap

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

O valor 'name' da reivindicação JSON é definido para Type após a tradução usando este mapeamento.

O valor padrão é ClaimTypeMapping.OutboundClaimTypeMap

SetDefaultTimesOnTokenCreation

Recebe ou define um bool que controla se a criação de tokens irá definir por defeito 'exp', 'nbf' e 'iat' se não for especificado.

(Herdado de TokenHandler)
ShortClaimTypeProperty

Obtém ou define o nome da Properties propriedade do will conter a reivindicação JSON original 'name' se ocorreu um mapeamento quando o Claim(s) o(s) foram criados.

Veja <também cref="P:System.IdentityModel.Tokens.Jwt.JwtSecurityTokenHandler.InboundClaimTypeMap"></veja também> para mais informações.

TokenLifetimeInMinutes

Obtém ou define a vida útil do token em minutos.

(Herdado de TokenHandler)
TokenType

Obtém o tipo do JwtSecurityToken.

Métodos

Nome Descrição
CanReadToken(String)

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

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

CanReadToken(XmlReader)

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

(Herdado de SecurityTokenHandler)
CreateActorValue(ClaimsIdentity)

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

CreateClaimsIdentity(JwtSecurityToken, String, TokenValidationParameters)

Cria um ClaimsIdentity a partir de um JwtSecurityToken.

CreateEncodedJwt(SecurityTokenDescriptor)

Devolve um Json Web Token (JWT).

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

Cria um JWT em 'Compact Serialization Format'.

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

Cria um JWT em 'Compact Serialization Format'.

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

Cria um JWT em 'Compact Serialization Format'.

CreateJwtSecurityToken(SecurityTokenDescriptor)

Cria um Json Web Token (JWT).

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 Json Web Token (JWT).

DecryptToken(JwtSecurityToken, TokenValidationParameters)

Descifra um JWE e devolve o texto claro

ReadJwtToken(String)

Converte uma cadeia numa instância de JwtSecurityToken.

ReadToken(String)

Converte uma cadeia numa instância de JwtSecurityToken.

ReadToken(XmlReader, TokenValidationParameters)

Desserializa o token com o .TokenValidationParameters

ReadToken(XmlReader)

Recebe o token de segurança.

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

Devolve a SecurityKey para usar ao validar a assinatura de um token.

ResolveTokenDecryptionKey(String, JwtSecurityToken, TokenValidationParameters)

Devolve um SecurityKey para usar ao desencriptar um JWE.

ValidateAudience(IEnumerable<String>, JwtSecurityToken, TokenValidationParameters)

Determina se as audiências encontradas num 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 é um valor esperado.

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

Valida a vida útil de um JwtSecurityToken.

ValidateSignature(String, TokenValidationParameters)

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

ValidateToken(String, TokenValidationParameters, SecurityToken)

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

ValidateToken(XmlReader, TokenValidationParameters, SecurityToken)

Lê e valida um token usando um xmlReader e TokenValidationParameters

(Herdado de SecurityTokenHandler)
ValidateTokenAsync(SecurityToken, TokenValidationParameters)

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

(Herdado de TokenHandler)
ValidateTokenAsync(String, TokenValidationParameters)

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

ValidateTokenPayload(JwtSecurityToken, TokenValidationParameters)

Valida a carga útil JSON de um JwtSecurityToken.

ValidateTokenReplay(Nullable<DateTime>, String, TokenValidationParameters)

Determina se a JwtSecurityToken já está validado.

WriteToken(SecurityToken)

Serializa a JwtSecurityToken num JWT em Formato de Serialização Compacta.

WriteToken(XmlWriter, SecurityToken)

Serializa para XML um token do tipo tratado por esta instância.

Aplica-se a