TokenValidationParameters Classe
Definição
Importante
Algumas informações se referem a produtos de pré-lançamento que podem ser substancialmente modificados antes do lançamento. A Microsoft não oferece garantias, expressas ou implícitas, das informações aqui fornecidas.
Contém um conjunto de parâmetros que são usados por um SecurityTokenHandler ao validar um SecurityToken.
public class TokenValidationParameters
type TokenValidationParameters = class
Public Class TokenValidationParameters
- Herança
-
TokenValidationParameters
Construtores
| Nome | Description |
|---|---|
| TokenValidationParameters() |
Inicializa uma nova instância da classe TokenValidationParameters. |
| TokenValidationParameters(TokenValidationParameters) |
Construtor de cópia para TokenValidationParameters. |
Campos
| Nome | Description |
|---|---|
| DefaultAuthenticationType |
Esse é o valor padrão da criação de AuthenticationType um ClaimsIdentity.
O valor é |
| DefaultClockSkew |
Padrão para a distorção do relógio. |
| DefaultMaximumTokenSizeInBytes |
Padrão para o tamanho máximo do token. |
Propriedades
| Nome | Description |
|---|---|
| ActorValidationParameters |
Obtém ou define TokenValidationParameters. |
| AlgorithmValidator |
Obtém ou define um delegado usado para validar o algoritmo criptográfico usado. |
| AudienceValidator |
Obtém ou define um delegado que será usado para validar o público-alvo. |
| AuthenticationType |
Obtém ou define o AuthenticationType ao criar um ClaimsIdentity. |
| ClockSkew |
Obtém ou define a distorção do relógio a ser aplicada ao validar uma hora. |
| ConfigurationManager |
Se definida, essa propriedade será usada para obter o emissor e as chaves de assinatura associadas ao ponto de extremidade de metadados de Issuer. As chaves de emissor e de assinatura obtidas serão usadas junto com as presentes no TokenValidationParameters para validação do token de entrada. |
| CryptoProviderFactory |
Os usuários podem substituir o padrão CryptoProviderFactory com essa propriedade. Essa fábrica será usada para criar provedores de assinatura. |
| DebugId |
Obtém ou define uma cadeia de caracteres que ajuda na configuração de pontos de interrupção ao depurar. |
| IgnoreTrailingSlashWhenValidatingAudience |
Obtém ou define um booliano que controla se um '/' é significativo no final da audiência.
O padrão é |
| IncludeTokenOnFailedValidation |
Obtém ou define o sinalizador que indica se a validação falha deve ser incluída SecurityToken . |
| InstancePropertyBag |
Obtém um IDictionary<TKey,TValue> que é exclusivo para essa instância. A chamada Clone() resultará em uma nova instância deste IDictionary. |
| IsClone |
Obtém um valor que indica se Clone() foi chamado para obter essa instância. |
| IssuerSigningKey |
Obtém ou define o SecurityKey que deve ser usado para validação de assinatura. |
| IssuerSigningKeyResolver |
Obtém 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 assinatura usando o TokenValidationParameters e BaseConfiguration. |
| IssuerSigningKeys |
Obtém ou define um IEnumerable<T> usado para validação de assinatura. |
| 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 |
Obtém ou define um delegado que será usado para validar o emissor do token. |
| IssuerValidatorUsingConfiguration |
Obtém ou define um delegado que será usado para validar o emissor do token. |
| LifetimeValidator |
Obtém ou define um delegado que será usado para validar o tempo de vida do token |
| LogTokenId |
Obtém ou define um Boolean que decidirá se a declaração do identificador de token precisa ser registrada.
O valor padrão é |
| LogValidationExceptions |
Obtém ou define um Boolean que decidirá se a falha de validação precisa ser registrada como um erro.
O valor padrão é |
| NameClaimType |
Obtém ou define um String que define o NameClaimType. |
| NameClaimTypeRetriever |
Obtém ou define um delegado que será chamado para definir a propriedade NameClaimType depois de validar um token. |
| PropertyBag |
Obtém ou define o IDictionary<TKey,TValue> que contém uma coleção de pares de chave/valor personalizados. Isso permite a adição de parâmetros que podem ser usados em cenários de validação de token personalizado. |
| RefreshBeforeValidation |
Obtém ou define um booliano para controlar se a configuração precisa ser atualizada antes da validação do token. |
| RequireAudience |
Obtém ou define um valor que indica se os tokens SAML ou JWT devem ter pelo menos um AudienceRestriction.
O padrão é |
| RequireExpirationTime |
Obtém ou define um valor que indica se os tokens devem ter um valor de "expiração".
O padrão é |
| RequireSignedTokens |
Obtém ou define um valor que indica se um SecurityToken pode ser considerado válido se não for assinado.
O padrão é |
| RoleClaimType |
Obtém ou define o String que define o RoleClaimType. |
| RoleClaimTypeRetriever |
Obtém ou define um delegado que será chamado para definir a propriedade RoleClaimType depois de validar um token. |
| SaveSigninToken |
Obtém ou define um booliano para controlar se o token original deve ser salvo após a validação do token de segurança. |
| SignatureValidator |
Obtém 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 TokenValidationParametersBaseConfiguration. |
| TokenDecryptionKey |
Obtém ou define o SecurityKey que deve ser usado para descriptografia. |
| TokenDecryptionKeyResolver |
Obtém ou define um delegado que será chamado para recuperar um SecurityKey usado para descriptografia. |
| TokenDecryptionKeys |
Obtém ou define o IEnumerable<T> que deve ser usado para descriptografar tokens de entrada. |
| TokenReader |
Obtém ou define um delegado que será usado para ler o token. |
| TokenReplayCache |
Obtém ou define os ITokenReplayCache tokens do repositório que podem ser verificados para ajudar a detectar a reprodução de token. |
| TokenReplayValidator |
Obtém ou define um delegado que será usado para validar a reprodução de token do token |
| TransformBeforeSignatureValidation |
Obtém ou define um delegado que será chamado para transformar um token em um formato com suporte antes da validação. |
| TryAllDecryptionKeys |
Obtém ou define um valor que indica se todos TokenDecryptionKeys devem ser tentados durante a descriptografia de token quando uma chave não é correspondida ao token 'kid' ou se o token 'kid' está vazio.
O padrão é |
| TryAllIssuerSigningKeys |
Obtém ou define um valor que indica se todos IssuerSigningKeys devem ser tentados durante a validação de assinatura quando uma chave não é correspondida ao token 'kid' ou se o token 'kid' está vazio.
O padrão é |
| TryReadJwtClaim |
Obtém ou define o delegado que será chamado ao ler declarações de conteúdo e cabeçalho do Token Web JSON. |
| TypeValidator |
Obtém 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 DEVERÁ ser gerada pelo delegado. Observação: o parâmetro 'type' poderá ser nulo se não puder ser extraído de seu local habitual. As implementações que precisam resolvê-lo 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 |
Obtém ou define um valor que indica se um token de ator é detectado, se ele deve ser validado.
O padrão é |
| ValidateAudience |
Obtém ou define um booliano para controlar se o público-alvo será validado durante a validação do token. |
| ValidateIssuer |
Obtém ou define um booliano para controlar se o emissor será validado durante a validação do token. |
| ValidateIssuerSigningKey |
Obtém ou define um booliano que controla se a SecurityKey validação do que assinou o securityToken é chamada. |
| ValidateLifetime |
Obtém ou define um booliano para controlar se o tempo de vida será validado durante a validação do token. |
| ValidateSignatureLast |
Obtém ou define um booliano que controla a ordem de validação do conteúdo e da assinatura durante a validação do token. |
| ValidateTokenReplay |
Obtém ou define um booliano para controlar se a reprodução do token será validada durante a validação do token. |
| ValidateWithLKG |
Obtém ou define um booliano para controlar se a configuração LKG será usada para validação de token. |
| ValidAudience |
Obtém ou define uma cadeia de caracteres que representa um público-alvo válido que será usado para verificar o público-alvo do token.
O padrão é |
| ValidAudiences |
Obtém ou define o IEnumerable<T> que contém públicos válidos que serão usados para verificar o público-alvo do token.
O padrão é |
| ValidIssuer |
Obtém ou define um String emissor válido que será usado para verificar o emissor do token.
O padrão é |
| ValidIssuers |
Obtém ou define o IEnumerable<T> que contém emissores válidos que serão usados para verificar o emissor do token.
O padrão é |
| ValidTypes |
Obtém ou define o IEnumerable<T> que contém tipos válidos que serão usados para verificar a declaração de "digitação" do cabeçalho JWT.
Se essa propriedade não estiver definida, a declaração de cabeçalho 'typ' não será validada e todos os tipos serão aceitos.
No caso de um JWE, essa propriedade só se aplicará ao cabeçalho do token interno.
O padrão é |
Métodos
| Nome | Description |
|---|---|
| Clone() |
Retorna uma nova instância com TokenValidationParameters valores copiados desse objeto. |
| CreateClaimsIdentity(SecurityToken, String) |
Cria um ClaimsIdentity uso: 'NameClaimType': se NameClaimTypeRetriever estiver definido, chame o delegado, caso contrário, chame NameClaimType. Se o resultado for uma cadeia de caracteres nula ou vazia, use DefaultNameClaimType .'RoleClaimType': se RoleClaimTypeRetriever estiver definido, chame o delegado, caso contrário, chame RoleClaimType. Se o resultado for uma cadeia de caracteres nula ou vazia, use DefaultRoleClaimType . |
Métodos de Extensão
| Nome | Description |
|---|---|
| EnableAadSigningKeyIssuerValidation(TokenValidationParameters) |
Habilita a validação do emissor das chaves de assinatura usadas pelo AAD (plataforma de identidade da Microsoft) no emissor do token. |
| EnableEntraIdSigningKeyCloudInstanceValidation(TokenValidationParameters) |
Habilita a validação da instância de nuvem das chaves de assinatura de token Microsoft Entra ID. |