OpenIdConnectHandler 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.
Um manipulador de autenticação por solicitação para o OpenIdConnectAuthenticationMiddleware.
public ref class OpenIdConnectHandler : Microsoft::AspNetCore::Authentication::RemoteAuthenticationHandler<Microsoft::AspNetCore::Builder::OpenIdConnectOptions ^>
public ref class OpenIdConnectHandler : Microsoft::AspNetCore::Authentication::RemoteAuthenticationHandler<Microsoft::AspNetCore::Authentication::OpenIdConnect::OpenIdConnectOptions ^>, Microsoft::AspNetCore::Authentication::IAuthenticationSignOutHandler
public class OpenIdConnectHandler : Microsoft.AspNetCore.Authentication.RemoteAuthenticationHandler<Microsoft.AspNetCore.Builder.OpenIdConnectOptions>
public class OpenIdConnectHandler : Microsoft.AspNetCore.Authentication.RemoteAuthenticationHandler<Microsoft.AspNetCore.Authentication.OpenIdConnect.OpenIdConnectOptions>, Microsoft.AspNetCore.Authentication.IAuthenticationSignOutHandler
type OpenIdConnectHandler = class
inherit RemoteAuthenticationHandler<OpenIdConnectOptions>
type OpenIdConnectHandler = class
inherit RemoteAuthenticationHandler<OpenIdConnectOptions>
interface IAuthenticationSignOutHandler
interface IAuthenticationHandler
Public Class OpenIdConnectHandler
Inherits RemoteAuthenticationHandler(Of OpenIdConnectOptions)
Public Class OpenIdConnectHandler
Inherits RemoteAuthenticationHandler(Of OpenIdConnectOptions)
Implements IAuthenticationSignOutHandler
- Herança
-
OpenIdConnectHandler
- Herança
-
OpenIdConnectHandler
- Implementações
Construtores
| Nome | Description |
|---|---|
| OpenIdConnectHandler(HttpClient, HtmlEncoder) |
Um manipulador de autenticação por solicitação para o OpenIdConnectAuthenticationMiddleware. |
| OpenIdConnectHandler(IOptionsMonitor<OpenIdConnectOptions>, ILoggerFactory, HtmlEncoder, UrlEncoder, ISystemClock) |
Obsoleto.
Inicializa uma nova instância de OpenIdConnectHandler. |
| OpenIdConnectHandler(IOptionsMonitor<OpenIdConnectOptions>, ILoggerFactory, HtmlEncoder, UrlEncoder) |
Inicializa uma nova instância de OpenIdConnectHandler. |
Propriedades
| Nome | Description |
|---|---|
| Backchannel |
Obtém o HttpClient usado para se comunicar com o provedor de identidade remoto. |
| ClaimsIssuer |
Obtém o emissor que deve ser usado quando quaisquer declarações são emitidas. (Herdado de AuthenticationHandler<TOptions>) |
| Clock |
Obsoleto.
Obtém 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 não será fornecida, o que não fará nada quando os métodos forem chamados. |
| HtmlEncoder |
Obtém HtmlEncoder. |
| Logger |
Obtém 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 a opção IOptionsMonitor<TOptions> de detectar alterações nas opções. (Herdado de AuthenticationHandler<TOptions>) |
| OriginalPath |
Obtém o caminho, conforme visto pelo middleware de autenticação. (Herdado de AuthenticationHandler<TOptions>) |
| OriginalPathBase |
Obtém a base de caminho, conforme visto pelo middleware de autenticação. (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 a esse manipulador de autenticação. (Herdado de AuthenticationHandler<TOptions>) |
| SignInScheme |
O esquema de autenticação usado por padrão para entrada. (Herdado de RemoteAuthenticationHandler<TOptions>) |
| TimeProvider |
Obtém a hora atual, principalmente para teste de unidade. (Herdado de AuthenticationHandler<TOptions>) |
| UrlEncoder |
Obtém UrlEncoder. (Herdado de AuthenticationHandler<TOptions>) |
Métodos
| Nome | Description |
|---|---|
| AuthenticateAsync() |
Autentique a solicitação atual. (Herdado de AuthenticationHandler<TOptions>) |
| BuildRedirectUri(String) |
Constrói uma URL absoluta para o especificado |
| ChallengeAsync(AuthenticationProperties) |
Desafie a solicitação atual. (Herdado de AuthenticationHandler<TOptions>) |
| CreateEventsAsync() |
Cria uma nova instância da instância de eventos. |
| ForbidAsync(AuthenticationProperties) |
Proíba a solicitação atual. (Herdado de AuthenticationHandler<TOptions>) |
| 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>) |
| GetUserInformationAsync(OpenIdConnectMessage, JwtSecurityToken, AuthenticationTicket) |
Vai para o ponto de extremidade UserInfo para recuperar declarações adicionais e adicionar declarações exclusivas à identidade fornecida. |
| GetUserInformationAsync(OpenIdConnectMessage, JwtSecurityToken, ClaimsPrincipal, AuthenticationProperties) |
Vai para o ponto de extremidade UserInfo para recuperar declarações adicionais e adicionar declarações exclusivas à identidade fornecida. |
| HandleAccessDeniedErrorAsync(AuthenticationProperties) |
Tipos derivados podem substituir esse método para lidar com erros de acesso negados. (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) |
Responde a um desafio 401. Envia uma mensagem OpenIdConnect à 'autoridade de identidade' para obter uma identidade. |
| HandleForbiddenAsync(AuthenticationProperties) |
Substitua esse método para manipular o Forbid. (Herdado de RemoteAuthenticationHandler<TOptions>) |
| HandleRemoteAuthenticateAsync() |
Invocado para processar mensagens OpenIdConnect de entrada. |
| HandleRemoteSignOutAsync() |
Lida com solicitações de saída remotas enviadas pelo provedor de identidade. |
| HandleRequestAsync() |
Manipula a solicitação de autenticação atual. |
| HandleSignOutAsync(SignOutContext) |
Redirecionar o usuário para o provedor de identidade para sair |
| HandleSignOutCallbackAsync() |
Resposta ao retorno de chamada do provedor OpenId após o término da sessão. |
| HandleUnauthorizedAsync(ChallengeContext) |
Responde a um desafio 401. Envia uma mensagem OpenIdConnect à 'autoridade de identidade' para obter uma identidade. |
| InitializeAsync(AuthenticationScheme, HttpContext) |
Inicialize o manipulador, resolva as opções e valide-as. (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 se inicializar. (Herdado de AuthenticationHandler<TOptions>) |
| RedeemAuthorizationCodeAsync(OpenIdConnectMessage) |
Resgata o código de autorização para tokens no ponto de extremidade do token. |
| 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>) |
| SignOutAsync(AuthenticationProperties) |
Redirecionar o usuário para o provedor de identidade para sair |
| ValidateCorrelationId(AuthenticationProperties) |
Valida se a solicitação atual está correlacionada com a solicitação de autenticação remota atual. (Herdado de RemoteAuthenticationHandler<TOptions>) |