OAuthHandler<TOptions> Classe

Definição

Namespace:

Microsoft.AspNetCore.Authentication.OAuth

Assembly:

Microsoft.AspNetCore.Authentication.OAuth.dll

Pacote:

Microsoft.AspNetCore.App.Ref v8.0.0

Um manipulador de autenticação que dá suporte ao OAuth.

public class OAuthHandler<TOptions> : Microsoft.AspNetCore.Authentication.RemoteAuthenticationHandler<TOptions> where TOptions : OAuthOptions, new()

type OAuthHandler<'Options (requires 'Options :> OAuthOptions and 'Options : (new : unit -> 'Options))> = class
    inherit RemoteAuthenticationHandler<'Options (requires 'Options :> OAuthOptions and 'Options : (new : unit -> 'Options))>

Public Class OAuthHandler(Of TOptions)
Inherits RemoteAuthenticationHandler(Of TOptions)

Parâmetros de tipo

TOptions

O tipo de opções.

Herança

Object

AuthenticationHandler<TOptions>

RemoteAuthenticationHandler<TOptions>

OAuthHandler<TOptions>

Derivado

Microsoft.AspNetCore.Authentication.Facebook.FacebookHandler

Microsoft.AspNetCore.Authentication.Google.GoogleHandler

Microsoft.AspNetCore.Authentication.MicrosoftAccount.MicrosoftAccountHandler

Construtores

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

Propriedades

Backchannel	Obtém a HttpClient instância usada para se comunicar com o provedor de autenticação remota.
ChallengeCalled	Um manipulador de autenticação que dá suporte ao OAuth. (Herdado de AuthenticationHandler<TOptions>)
ClaimsIssuer	Obtém o emissor que deve ser usado quando quaisquer declarações são emitidas. (Herdado de AuthenticationHandler<TOptions>)
Clock	Obsoleto. Obtém o ISystemClock. (Herdado de AuthenticationHandler<TOptions>)
Context	Obtém ou define o HttpContext. (Herdado de AuthenticationHandler<TOptions>)
CurrentUri	Obtém a URL atual absoluta. (Herdado de AuthenticationHandler<TOptions>)
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 será fornecida, que não fará nada quando os métodos forem chamados.
InitializeResult	Um manipulador de autenticação que dá suporte ao OAuth. (Herdado de AuthenticationHandler<TOptions>)
Logger	Obtém o ILogger. (Herdado de AuthenticationHandler<TOptions>)
Options	Obtém ou define as opções associadas a esse manipulador de autenticação. (Herdado de AuthenticationHandler<TOptions>)
OptionsMonitor	Obtém o IOptionsMonitor<TOptions> para detectar alterações nas opções. (Herdado de AuthenticationHandler<TOptions>)
OriginalPath	Obtém o caminho como visto pelo middleware de autenticação. (Herdado de AuthenticationHandler<TOptions>)
OriginalPathBase	Obtém a base do caminho, conforme visto pelo middleware de autenticação. (Herdado de AuthenticationHandler<TOptions>)
PriorHandler	Um manipulador de autenticação que dá suporte ao OAuth. (Herdado de AuthenticationHandler<TOptions>)
Request	Obtém o HttpRequest associado à solicitação atual. (Herdado de AuthenticationHandler<TOptions>)
Response	Obtém o HttpResponse associado à solicitação atual. (Herdado de AuthenticationHandler<TOptions>)
Scheme	Obtém ou define o AuthenticationScheme associado com esse manipulador de autenticação. (Herdado de AuthenticationHandler<TOptions>)
SignInAccepted	Um manipulador de autenticação que dá suporte ao OAuth. (Herdado de AuthenticationHandler<TOptions>)
SignInScheme	O esquema de autenticação usado por padrão para entrada. (Herdado de RemoteAuthenticationHandler<TOptions>)
SignOutAccepted	Um manipulador de autenticação que dá suporte ao OAuth. (Herdado de AuthenticationHandler<TOptions>)
TimeProvider	Obtém a hora atual, principalmente para teste de unidade. (Herdado de AuthenticationHandler<TOptions>)
UrlEncoder	Obtém o UrlEncoder. (Herdado de AuthenticationHandler<TOptions>)

Métodos

AuthenticateAsync()	Autentique a solicitação atual. (Herdado de AuthenticationHandler<TOptions>)
AuthenticateAsync(AuthenticateContext)	Um manipulador de autenticação que dá suporte ao OAuth. (Herdado de AuthenticationHandler<TOptions>)
BuildChallengeUrl(AuthenticationProperties, String)	Constrói a URL do desafio OAuth.
BuildRedirectUri(String)	Constrói uma URL absoluta para o especificado targetPath. (Herdado de AuthenticationHandler<TOptions>)
ChallengeAsync(AuthenticationProperties)	Desafie a solicitação atual. (Herdado de AuthenticationHandler<TOptions>)
ChallengeAsync(ChallengeContext)	Um manipulador de autenticação que dá suporte ao OAuth. (Herdado de AuthenticationHandler<TOptions>)
CreateEventsAsync()	Cria uma nova instância da instância de eventos.
CreateTicketAsync(ClaimsIdentity, AuthenticationProperties, OAuthTokenResponse)	Cria um AuthenticationTicket do especificado tokens.
ExchangeCodeAsync(OAuthCodeExchangeContext)	Troca o código de autorização por um token de autorização do provedor remoto.
FinishResponseAsync()	Gancho que é chamado quando a resposta prestes a ser enviada (Herdado de AuthenticationHandler<TOptions>)
ForbidAsync(AuthenticationProperties)	Proíba a solicitação atual. (Herdado de AuthenticationHandler<TOptions>)
FormatScope()	Formate a Scope propriedade .
FormatScope(IEnumerable<String>)	Formatar uma lista de escopos OAuth.
GenerateCorrelationId(AuthenticationProperties)	Produz um cookie que contém um nonce usado para correlacionar a solicitação de autenticação remota atual. (Herdado de RemoteAuthenticationHandler<TOptions>)
GenerateCorrelationId(AuthenticationProperties)	Um manipulador de autenticação que dá suporte ao OAuth. (Herdado de RemoteAuthenticationHandler<TOptions>)
GetDescriptions(DescribeSchemesContext)	Um manipulador de autenticação que dá suporte ao OAuth. (Herdado de AuthenticationHandler<TOptions>)
HandleAccessDeniedErrorAsync(AuthenticationProperties)	Tipos derivados podem substituir esse método para lidar com erros de acesso negado. (Herdado de RemoteAuthenticationHandler<TOptions>)
HandleAuthenticateAsync()	Permite que tipos derivados manipulem a autenticação. (Herdado de RemoteAuthenticationHandler<TOptions>)
HandleAuthenticateOnceAsync()	Usado para garantir que HandleAuthenticateAsync seja invocado apenas uma vez. As chamadas subsequentes retornarão o mesmo resultado de autenticação. (Herdado de AuthenticationHandler<TOptions>)
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. (Herdado de AuthenticationHandler<TOptions>)
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, 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 manipular o Forbid. (Herdado de RemoteAuthenticationHandler<TOptions>)
HandleForbiddenAsync(ChallengeContext)	Um manipulador de autenticação que dá suporte ao OAuth. (Herdado de RemoteAuthenticationHandler<TOptions>)
HandleRemoteAuthenticateAsync()	Autentique a identidade do usuário com o provedor de identidade. O método processa a solicitação no ponto de extremidade definido por CallbackPath.
HandleRemoteCallbackAsync()	Um manipulador de autenticação que dá suporte ao OAuth. (Herdado de RemoteAuthenticationHandler<TOptions>)
HandleRequestAsync()	Manipula a solicitação de autenticação atual. (Herdado de RemoteAuthenticationHandler<TOptions>)
HandleSignInAsync(SignInContext)	Um manipulador de autenticação que dá suporte ao OAuth. (Herdado de RemoteAuthenticationHandler<TOptions>)
HandleSignOutAsync(SignOutContext)	Um manipulador de autenticação que dá suporte ao OAuth. (Herdado de RemoteAuthenticationHandler<TOptions>)
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, 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.) (Herdado de AuthenticationHandler<TOptions>)
InitializeAsync(AuthenticationScheme, HttpContext)	Inicialize o manipulador resolve as opções e valide-as. (Herdado de AuthenticationHandler<TOptions>)
InitializeAsync(TOptions, HttpContext, ILogger, UrlEncoder)	Inicializar é chamado uma vez por solicitação para contextualizar essa instância com o estado apropriado. (Herdado de AuthenticationHandler<TOptions>)
InitializeEventsAsync()	Inicializa o objeto de eventos, chamado uma vez por solicitação por InitializeAsync(AuthenticationScheme, HttpContext). (Herdado de AuthenticationHandler<TOptions>)
InitializeHandlerAsync()	Chamado após opções/eventos terem sido inicializados para que o manipulador termine de inicializar a si mesmo. (Herdado de AuthenticationHandler<TOptions>)
ResolveTarget(String)	Resolve o esquema para o qual essa operação de autenticação é encaminhada. (Herdado de AuthenticationHandler<TOptions>)
ShouldHandleRequestAsync()	Obtém um valor que determina se a solicitação de autenticação atual deve ser tratada por HandleRequestAsync(). (Herdado de RemoteAuthenticationHandler<TOptions>)
ShouldHandleScheme(String, Boolean)	Um manipulador de autenticação que dá suporte ao OAuth. (Herdado de AuthenticationHandler<TOptions>)
SignInAsync(SignInContext)	Um manipulador de autenticação que dá suporte ao OAuth. (Herdado de AuthenticationHandler<TOptions>)
SignOutAsync(SignOutContext)	Um manipulador de autenticação que dá suporte ao OAuth. (Herdado de AuthenticationHandler<TOptions>)
ValidateCorrelationId(AuthenticationProperties)	Valida se a solicitação atual está correlacionada com a solicitação de autenticação remota atual. (Herdado de RemoteAuthenticationHandler<TOptions>)
ValidateCorrelationId(AuthenticationProperties)	Um manipulador de autenticação que dá suporte ao OAuth. (Herdado de RemoteAuthenticationHandler<TOptions>)