AuthenticationHandler<TOptions> Classe

  • Referência

Definição

Namespace:
Microsoft.AspNetCore.Authentication
Assembly:
Microsoft.AspNetCore.Authentication.dll
Pacote:
Microsoft.AspNetCore.Authentication v1.0.0
Pacote:
Microsoft.AspNetCore.Authentication v1.1.0
Pacote:
Microsoft.AspNetCore.Authentication v2.0.0
Pacote:
Microsoft.AspNetCore.Authentication v2.1.0
Pacote:
Microsoft.AspNetCore.Authentication v2.2.0
Pacote:
Microsoft.AspNetCore.App.Ref v3.0.1
Pacote:
Microsoft.AspNetCore.App.Ref v3.1.10
Pacote:
Microsoft.AspNetCore.App.Ref v5.0.0
Pacote:
Microsoft.AspNetCore.App.Ref v6.0.6
Pacote:
Microsoft.AspNetCore.App.Ref v7.0.5
Pacote:
Microsoft.AspNetCore.App.Ref v8.0.0
Pacote:
Microsoft.AspNetCore.App.Ref v9.0.0-rc.2.24474.3
Origem:
AuthenticationHandler.cs
Origem:
AuthenticationHandler.cs
Origem:
AuthenticationHandler.cs

Uma abstração opinativa para implementar 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
Object
AuthenticationHandler<TOptions>
Derivado
Implementações
IAuthenticationHandler IAuthenticationHandler

Construtores

AuthenticationHandler<TOptions>()

Uma abstração opinativa para implementar IAuthenticationHandler.
AuthenticationHandler<TOptions>(IOptionsMonitor<TOptions>, ILoggerFactory, UrlEncoder, ISystemClock)
Obsoleto.

Inicializa uma nova instância de AuthenticationHandler<TOptions>.
AuthenticationHandler<TOptions>(IOptionsMonitor<TOptions>, ILoggerFactory, UrlEncoder)

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

Propriedades

ChallengeCalled

Uma abstração opinativa para implementar IAuthenticationHandler.
ClaimsIssuer

Obtém o emissor que deve ser usado quando quaisquer declarações são emitidas.
Clock
Obsoleto.

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 dão ao aplicativo controle em determinados pontos em que o processamento está ocorrendo. Se não for fornecido, uma instância padrão não será fornecida, o que não fará nada quando os métodos forem chamados.
InitializeResult

Uma abstração opinativa para implementar IAuthenticationHandler.
Logger

Obtém o ILogger.
Options

Obtém ou define as opções associadas a esse 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 de caminho, conforme visto pelo middleware de autenticação.
PriorHandler

Uma abstração opinativa para implementar IAuthenticationHandler.
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 associado a esse manipulador de autenticação.
SignInAccepted

Uma abstração opinativa para implementar IAuthenticationHandler.
SignOutAccepted

Uma abstração opinativa para implementar IAuthenticationHandler.
TimeProvider

Obtém a hora atual, principalmente para teste de unidade.
UrlEncoder

Obtém o UrlEncoder.

Métodos

AuthenticateAsync()

Autentique a solicitação atual.
AuthenticateAsync(AuthenticateContext)

Uma abstração opinativa para implementar IAuthenticationHandler.
BuildRedirectUri(String)

Constrói uma URL absoluta para o targetPathespecificado.
ChallengeAsync(AuthenticationProperties)

Desafie a solicitação atual.
ChallengeAsync(ChallengeContext)

Uma abstração opinativa para implementar IAuthenticationHandler.
CreateEventsAsync()

Cria uma nova instância da instância de eventos.
FinishResponseAsync()

Gancho que é chamado quando a resposta prestes a ser enviada
ForbidAsync(AuthenticationProperties)

Proíba a solicitação atual.
GetDescriptions(DescribeSchemesContext)

Uma abstração opinativa para implementar IAuthenticationHandler.
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 questões de desafio 401, se um esquema de autenticação em questão lida com uma interação de autenticação como parte do fluxo de solicitação. (como adicionar um cabeçalho de resposta ou alterar o resultado 401 para 302 de uma página de logon ou local de entrada externo).)
HandleForbiddenAsync(AuthenticationProperties)

Substitua esse método para manipular o Forbid.
HandleForbiddenAsync(ChallengeContext)

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

Chamado uma vez pelo código comum após a inicialização. Se um middleware de autenticação responder diretamente a caminhos especificamente conhecidos, ele deverá substituir esse virtual, comparar o caminho da solicitação com seus caminhos conhecidos, fornecer qualquer informação de resposta conforme apropriado e true para interromper o processamento adicional.
HandleSignInAsync(SignInContext)

Uma abstração opinativa para implementar IAuthenticationHandler.
HandleSignOutAsync(SignOutContext)

Uma abstração opinativa para implementar IAuthenticationHandler.
HandleUnauthorizedAsync(ChallengeContext)

Substitua esse método para lidar com questões de desafio 401, se um esquema de autenticação em questão lida com uma interação de autenticação como parte do fluxo de solicitação. (como adicionar um cabeçalho de resposta ou alterar 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)

Inicializar é chamado uma vez por solicitação para contextualizar essa instância com o estado apropriado.
InitializeEventsAsync()

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

Chamado após opções/eventos terem sido inicializados para que o manipulador termine de se inicializar.
ResolveTarget(String)

Resolve o esquema para o qual essa operação de autenticação é encaminhada.
ShouldHandleScheme(String, Boolean)

Uma abstração opinativa para implementar IAuthenticationHandler.
SignInAsync(SignInContext)

Uma abstração opinativa para implementar IAuthenticationHandler.
SignOutAsync(SignOutContext)

Uma abstração opinativa para implementar IAuthenticationHandler.

Aplica-se a