AuthenticationHandler<TOptions> Classe

Definição

Uma abstração conceituada para implementação IAuthenticationHandler .

generic <typename TOptions>
 where TOptions : AuthenticationOptionspublic ref class AuthenticationHandler abstract : Microsoft::AspNetCore::Http::Features::Authentication::IAuthenticationHandler
generic <typename TOptions>
 where TOptions : AuthenticationSchemeOptionsgcnew()public ref class AuthenticationHandler abstract : Microsoft::AspNetCore::Authentication::IAuthenticationHandler
public abstract class AuthenticationHandler<TOptions> : Microsoft.AspNetCore.Http.Features.Authentication.IAuthenticationHandler where TOptions : AuthenticationOptions
public abstract class AuthenticationHandler<TOptions> : Microsoft.AspNetCore.Authentication.IAuthenticationHandler where TOptions : AuthenticationSchemeOptions, new()
type AuthenticationHandler<'Options (requires 'Options :> AuthenticationOptions)> = class
    interface IAuthenticationHandler
type AuthenticationHandler<'Options (requires 'Options :> AuthenticationSchemeOptions and 'Options : (new : unit -> 'Options))> = class
    interface IAuthenticationHandler
Public MustInherit Class AuthenticationHandler(Of TOptions)
Implements IAuthenticationHandler

Parâmetros de tipo

TOptions

O tipo para as opções usadas para configurar o manipulador de autenticação.

Herança
AuthenticationHandler<TOptions>
Derivado
Implementações

Construtores

AuthenticationHandler<TOptions>()
AuthenticationHandler<TOptions>(IOptionsMonitor<TOptions>, ILoggerFactory, UrlEncoder, ISystemClock)

Inicializa uma nova instância de AuthenticationHandler<TOptions>.

Propriedades

ChallengeCalled
ClaimsIssuer

Obtém o emissor que deve ser usado quando qualquer declaração é emitida.

Clock

Obtém o ISystemClock.

Context

Obtém ou define o HttpContext.

CurrentUri

Obtém a URL atual absoluta.

Events

O manipulador chama métodos nos eventos que fornecem ao controle do aplicativo determinados pontos em que o processamento está ocorrendo. Se não for fornecido, uma instância padrão será fornecida, que não fará nada quando os métodos forem chamados.

InitializeResult
Logger

Obtém o ILogger.

Options

Obtém ou define as opções associadas a este manipulador de autenticação.

OptionsMonitor

Obtém o IOptionsMonitor<TOptions> para detectar alterações nas opções.

OriginalPath

Obtém o caminho conforme visto pelo middleware de autenticação.

OriginalPathBase

Obtém a base do caminho conforme visto pelo middleware de autenticação.

PriorHandler
Request

Obtém o HttpRequest associado à solicitação atual.

Response

Obtém o HttpResponse associado à solicitação atual.

Scheme

Obtém ou define o AuthenticationScheme asssociated com este manipulador de autenticação.

SignInAccepted
SignOutAccepted
UrlEncoder

Obtém o UrlEncoder.

Métodos

AuthenticateAsync()

Autenticar a solicitação atual.

AuthenticateAsync(AuthenticateContext)
BuildRedirectUri(String)

Constrói uma URL absoluta para o especificado targetPath .

ChallengeAsync(AuthenticationProperties)

Desafiar a solicitação atual.

ChallengeAsync(ChallengeContext)
CreateEventsAsync()

Cria uma nova instância da instância de eventos.

FinishResponseAsync()

Gancho que é chamado quando a resposta está prestes a ser enviada

ForbidAsync(AuthenticationProperties)

Proíba a solicitação atual.

GetDescriptions(DescribeSchemesContext)
HandleAuthenticateAsync()

Permite que tipos derivados manipulem a autenticação.

HandleAuthenticateOnceAsync()

Usado para garantir que HandleAuthenticateAsync seja invocado apenas uma vez. As chamadas subsequentes retornarão o mesmo resultado de autenticação.

HandleAuthenticateOnceSafeAsync()

Usado para garantir que HandleAuthenticateAsync seja invocado apenas uma vez com segurança. As chamadas subsequentes retornarão o mesmo resultado de autenticação. Todas as exceções serão convertidas em um resultado de autenticação com falha que contém a exceção.

HandleChallengeAsync(AuthenticationProperties)

Substitua esse método para lidar com 401 preocupações de desafio, se um esquema de autenticação em questão tratar uma interação de autenticação como parte do fluxo de solicitação. (Como, por exemplo, adicionar um cabeçalho de resposta ou mudar o resultado 401 para 302 de uma página de logon ou local de entrada externo.)

HandleForbiddenAsync(AuthenticationProperties)

Substitua esse método para lidar com proíba.

HandleForbiddenAsync(ChallengeContext)

Substitua esse método para lidar com um desafio proibido.

HandleRequestAsync()

Chamado uma vez por código comum após a inicialização. Se um middleware de autenticação responder diretamente a caminhos especialmente conhecidos, ele deverá substituir essa virtual, comparar o caminho da solicitação com os caminhos conhecidos, fornecer todas as informações de resposta conforme apropriado e verdadeiro para interromper o processamento.

HandleSignInAsync(SignInContext)
HandleSignOutAsync(SignOutContext)
HandleUnauthorizedAsync(ChallengeContext)

Substitua esse método para lidar com 401 preocupações de desafio, se um esquema de autenticação em questão tratar uma interação de autenticação como parte do fluxo de solicitação. (Como, por exemplo, adicionar um cabeçalho de resposta ou mudar o resultado 401 para 302 de uma página de logon ou local de entrada externo.)

InitializeAsync(AuthenticationScheme, HttpContext)

Inicialize o manipulador, resolva as opções e valide-as.

InitializeAsync(TOptions, HttpContext, ILogger, UrlEncoder)

A inicialização é chamada uma vez por solicitação para Contextualize essa instância com o estado apropriado.

InitializeEventsAsync()

Inicializa o objeto Events, chamado uma vez por solicitação por InitializeAsync(AuthenticationScheme, HttpContext) .

InitializeHandlerAsync()

Chamado depois que as opções/eventos foram inicializados para que o manipulador termine a inicialização.

ResolveTarget(String)

Resolve o esquema para o qual esta operação de autenticação é encaminhada.

ShouldHandleScheme(String, Boolean)
SignInAsync(SignInContext)
SignOutAsync(SignOutContext)

Aplica-se a