TokenValidationParameters Classe

Definição

Espaço de Nomes:: Microsoft.IdentityModel.Tokens

Assemblagem:: Microsoft.IdentityModel.Tokens.dll

Pacote:: Microsoft.IdentityModel.Tokens v8.19.1

Importante

Algumas informações dizem respeito a um produto pré-lançado que pode ser substancialmente modificado antes de ser lançado. A Microsoft não faz garantias, de forma expressa ou implícita, em relação à informação aqui apresentada.

Contém um conjunto de parâmetros que são usados por a SecurityTokenHandler ao validar um SecurityToken.

public class TokenValidationParameters

type TokenValidationParameters = class

Public Class TokenValidationParameters

Herança: Object
TokenValidationParameters

Construtores

Name	Descrição
TokenValidationParameters()	Inicializa uma nova instância da TokenValidationParameters classe.
TokenValidationParameters(TokenValidationParameters)	Copiar construtor para TokenValidationParameters.

Campos

Name	Descrição
DefaultAuthenticationType	Este é o valor padrão de AuthenticationType ao criar um ClaimsIdentity. O valor é `"AuthenticationTypes.Federation"`. Para alterar o valor, defina AuthenticationType para um valor diferente.
DefaultClockSkew	Padrão para o desfasamento do relógio.
DefaultMaximumTokenSizeInBytes	Padrão para o tamanho máximo do token.

Propriedades

Name	Descrição
ActorValidationParameters	Obtém ou define TokenValidationParameters.
AlgorithmValidator	Obtém ou define um delegado usado para validar o algoritmo criptográfico utilizado.
AudienceValidator	Recebe ou define um delegado que será usado para validar o público.
AuthenticationType	Obtém ou define o AuthenticationType ao criar um ClaimsIdentity.
ClockSkew	Obtém ou define o desfasamento do relógio para se aplicar ao validar uma hora.
ConfigurationManager	Se definida, esta propriedade será usada para obter as chaves do emissor e de assinatura associadas ao endpoint de metadados de Issuer. As chaves do emissor e de assinatura obtidas serão então usadas juntamente com as presentes nos TokenValidationParameters para validação do token recebido.
CryptoProviderFactory	Os utilizadores podem sobrescrever o padrão CryptoProviderFactory com esta propriedade. Esta fábrica será usada para criar fornecedores de assinatura.
DebugId	Recebe ou define uma cadeia que ajuda a definir pontos de interrupção durante a depuração.
IgnoreTrailingSlashWhenValidatingAudience	Recebe ou define um booleano que controla se um '/' é significativo no final do público. A predefinição é `true`.
IncludeTokenOnFailedValidation	Recebe ou define o flag que indica se deve incluir o SecurityToken quando a validação falha.
InstancePropertyBag	Recebe um IDictionary<TKey,TValue> que é único para esta situação. A chamada Clone() resultará numa nova instância deste IDictionary.
IsClone	Obtém um valor que indica se Clone() foi chamado para obter esta instância.
IssuerSigningKey	Obtém ou define o SecurityKey que deve ser usado para validação de assinaturas.
IssuerSigningKeyResolver	Recebe ou define um delegado que será chamado para recuperar um SecurityKey usado para validação de assinatura.
IssuerSigningKeyResolverUsingConfiguration	Obtém ou define um delegado que será chamado para recuperar um SecurityKey usado para validação de assinaturas usando e TokenValidationParameters BaseConfiguration.
IssuerSigningKeys	Obtém ou definem e IEnumerable<T> são usados para validação de assinaturas.
IssuerSigningKeyValidator	Obtém ou define um delegado para validar o SecurityKey que assinou o token.
IssuerSigningKeyValidatorUsingConfiguration	Obtém ou define um delegado para validar o SecurityKey que assinou o token.
IssuerValidator	Recebe ou define um delegado que será usado para validar o emissor do token.
IssuerValidatorUsingConfiguration	Recebe ou define um delegado que será usado para validar o emissor do token.
LifetimeValidator	Recebe ou define um delegado que será usado para validar a vida útil do token
LogTokenId	Obtém ou define um Boolean que decidirá se a reivindicação do identificador do token precisa de ser registada. O valor predefinido é `true`.
LogValidationExceptions	Recebe ou define um Boolean que decidirá se a falha de validação precisa de ser registada como um erro. O valor padrão é `true` para compatibilidade retroativa do comportamento. Se definido como falso, as falhas de validação são registadas como Informação e depois lançadas.
NameClaimType	Obtém ou define um String que define o NameClaimType.
NameClaimTypeRetriever	Recebe ou define um delegado que será chamado para definir a propriedade NameClaimType após validar um token.
PropertyBag	Obtém ou define o IDictionary<TKey,TValue> que contém uma coleção de pares personalizados chave/valor. Isto permite a adição de parâmetros que poderiam ser usados em cenários personalizados de validação de tokens.
RefreshBeforeValidation	Recebe ou define um booleano para controlar se a configuração precisa de ser atualizada antes da validação do token.
RequireAudience	Recebe ou define um valor que indica se os tokens SAML ou JWT devem ter pelo menos uma AudienceRestriction. A predefinição é `true`.
RequireExpirationTime	Recebe ou define um valor que indica se os tokens devem ter um valor de 'expiração'. A predefinição é `true`.
RequireSignedTokens	Recebe ou define um valor que indica se um SecurityToken pode ser considerado válido se não estiver assinado. A predefinição é `true`.
RoleClaimType	Obtém ou define o String que define o RoleClaimType.
RoleClaimTypeRetriever	Recebe ou define um delegado que será chamado para definir a propriedade RoleClaimType após validar um token.
SaveSigninToken	Recebe ou define um booleano para controlar se o token original deve ser guardado depois de o token de segurança ser validado.
SignatureValidator	Recebe ou define um delegado que será usado para validar a assinatura do token.
SignatureValidatorUsingConfiguration	Obtém ou define um delegado que será usado para validar a assinatura do token usando o TokenValidationParameters e o BaseConfiguration.
TokenDecryptionKey	Obtém ou define o SecurityKey que deve ser usado para desencriptação.
TokenDecryptionKeyResolver	Recebe ou define um delegado que será chamado para recuperar um SecurityKey usado para desencriptação.
TokenDecryptionKeys	Obtém ou define o IEnumerable<T> que deve ser usado para desencriptar tokens de entrada.
TokenReader	Recebe ou define um delegado que será usado para ler o token.
TokenReplayCache	Obtém ou definem ITokenReplayCache que armazenam tokens que podem ser verificados para ajudar a detetar a repetição dos tokens.
TokenReplayValidator	Recebe ou define um delegado que será usado para validar a repetição do token
TransformBeforeSignatureValidation	Recebe ou define um delegado que será chamado para transformar um token para um formato suportado antes da validação.
TryAllDecryptionKeys	Recebe ou define um valor que indica se todos TokenDecryptionKeys devem ser tentados durante a desencriptação do token quando uma chave não está associada ao token 'kid' ou se o token 'kid' está vazio. A predefinição é `true`.
TryAllIssuerSigningKeys	Recebe ou define um valor que indica se todos IssuerSigningKeys devem ser tentados durante a validação da assinatura quando uma chave não está associada ao token 'kid' ou se o token 'kid' está vazio. A predefinição é `true`.
TryReadJwtClaim	Recebe ou define o delegado que será chamado ao ler o cabeçalho JSON Web Token e as reclamações de payload.
TypeValidator	Recebe ou define um delegado que será usado para validar o tipo do token. Se o tipo de token não puder ser validado, uma exceção DEVE ser lançada pelo delegado. Nota: o parâmetro 'tipo' pode ser nulo se não puder ser extraído da sua localização habitual. Implementações que precisam de resolver a partir de um local diferente podem usar o parâmetro 'token'.
ValidAlgorithms	Obtém ou define os algoritmos válidos para operações criptográficas.
ValidateActor	Recebe ou define um valor que indica se um token de ator é detetado, se deve ser validado. A predefinição é `false`.
ValidateAudience	Recebe ou define um booleano para controlar se o público será validado durante a validação do token.
ValidateIssuer	Recebe ou define um booleano para controlar se o emissor será validado durante a validação do token.
ValidateIssuerSigningKey	Obtém ou define um booleano que controla se a validação do SecurityKey que assinou o securityToken é chamada.
ValidateLifetime	Recebe ou define um booleano para controlar se a vida útil será validada durante a validação do token.
ValidateSignatureLast	Recebe ou define um booleano que controla a ordem de validação da carga útil e da assinatura durante a validação do token.
ValidateTokenReplay	Recebe ou define um booleano para controlar se a repetição do token será validada durante a validação do token.
ValidateWithLKG	Obtém ou define um booleano para controlar se a configuração LKG será usada para validação de tokens.
ValidAudience	Obtém ou define uma cadeia que representa uma audiência válida que será usada para verificar contra a audiência do token. A predefinição é `null`.
ValidAudiences	Obtém ou define o IEnumerable<T> que contém audiências válidas que serão usadas para verificar contra a audiência do token. A predefinição é `null`.
ValidIssuer	Obtém ou define um String que representa um emissor válido que será usado para verificar contra o emissor do token. A predefinição é `null`.
ValidIssuers	Obtém ou define o IEnumerable<T> que contém emissores válidos que serão usados para verificar contra o emissor do token. A predefinição é `null`.
ValidTypes	Obtém ou define o IEnumerable<T> que contém tipos válidos que serão usados para verificar contra a reivindicação 'type' do cabeçalho JWT. Se esta propriedade não for definida, a reivindicação do cabeçalho 'type' não será validada e todos os tipos serão aceites. No caso de um JWE, esta propriedade aplica-se APENAS ao cabeçalho interno do token. A predefinição é `null`.

Métodos

Name	Descrição
Clone()	Devolve uma nova instância de TokenValidationParameters com valores copiados deste objeto.
CreateClaimsIdentity(SecurityToken, String)	Cria uma ClaimsIdentity utilização: AuthenticationType 'NameClaimType': Se NomeClaimTypeRetriever estiver definido, chame delegar, caso contrário chame NameClaimType. Se o resultado for uma cadeia nula ou vazia, use DefaultNameClaimType . 'RoleClaimType': Se RoleClaimTypeRetriever estiver definido, chame delegar, caso contrário chame RoleClaimType. Se o resultado for uma cadeia nula ou vazia, use DefaultRoleClaimType .

Name

Descrição

Clone()

Devolve uma nova instância de TokenValidationParameters com valores copiados deste objeto.

CreateClaimsIdentity(SecurityToken, String)

Cria uma ClaimsIdentity utilização:

AuthenticationType

'NameClaimType': Se NomeClaimTypeRetriever estiver definido, chame delegar, caso contrário chame NameClaimType. Se o resultado for uma cadeia nula ou vazia, use DefaultNameClaimType

'RoleClaimType': Se RoleClaimTypeRetriever estiver definido, chame delegar, caso contrário chame RoleClaimType. Se o resultado for uma cadeia nula ou vazia, use DefaultRoleClaimType

Métodos da Extensão

Name	Descrição
EnableAadSigningKeyIssuerValidation(TokenValidationParameters)	Permite a validação do emissor das chaves de assinatura usadas pela plataforma de identidades da Microsoft (AAD) em relação ao emissor do token.
EnableEntraIdSigningKeyCloudInstanceValidation(TokenValidationParameters)	Permite a validação da instância cloud das chaves de assinatura do token Microsoft Entra ID.

Aplica-se a

Comentários

Esta página foi útil?