AuthenticationHandler<TOptions> Clase

Definición

Abstracción con opinión 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

Tipo de las opciones usadas para configurar el controlador de autenticación.

Herencia
AuthenticationHandler<TOptions>
Derivado
Implementaciones

Constructores

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

Inicializa una nueva instancia de la clase AuthenticationHandler<TOptions>.

Propiedades

ChallengeCalled
ClaimsIssuer

Obtiene el emisor que se debe usar cuando se emiten notificaciones.

Clock

Obtiene la estructura ISystemClock.

Context

Obtiene o establece el HttpContext.

CurrentUri

Obtiene la dirección URL actual absoluta.

Events

El controlador llama a métodos en los eventos que proporcionan el control de aplicación en determinados puntos en los que se está produciendo el procesamiento. Si no se proporciona, se ofrece una instancia predeterminada que no hace nada cuando se invocan los métodos.

InitializeResult
Logger

Obtiene la estructura ILogger.

Options

Obtiene o establece las opciones asociadas a este controlador de autenticación.

OptionsMonitor

Obtiene el IOptionsMonitor<TOptions> objeto para detectar cambios en las opciones.

OriginalPath

Obtiene la ruta de acceso que ve el middleware de autenticación.

OriginalPathBase

Obtiene la base de ruta de acceso tal y como ve el middleware de autenticación.

PriorHandler
Request

Obtiene el HttpRequest asociado a la solicitud actual.

Response

Obtiene el HttpResponse asociado a la solicitud actual.

Scheme

Obtiene o establece el AuthenticationScheme associado con este controlador de autenticación.

SignInAccepted
SignOutAccepted
UrlEncoder

Obtiene la estructura UrlEncoder.

Métodos

AuthenticateAsync()

Autenticar la solicitud actual.

AuthenticateAsync(AuthenticateContext)
BuildRedirectUri(String)

Construye una dirección URL absoluta para el especificado targetPath.

ChallengeAsync(AuthenticationProperties)

Impugnar la solicitud actual.

ChallengeAsync(ChallengeContext)
CreateEventsAsync()

Crea una nueva instancia de la instancia de eventos.

FinishResponseAsync()

Enlace al que se llama cuando se envía la respuesta a punto de enviarse

ForbidAsync(AuthenticationProperties)

Prohibir la solicitud actual.

GetDescriptions(DescribeSchemesContext)
HandleAuthenticateAsync()

Permite que los tipos derivados controle la autenticación.

HandleAuthenticateOnceAsync()

Se usa para asegurarse de que HandleAuthenticateAsync solo se invoca una vez. Las llamadas posteriores devolverán el mismo resultado de autenticación.

HandleAuthenticateOnceSafeAsync()

Se usa para asegurarse de que HandleAuthenticateAsync solo se invoca una vez de forma segura. Las llamadas posteriores devolverán el mismo resultado de autenticación. Las excepciones se convertirán en un resultado de autenticación con errores que contenga la excepción.

HandleChallengeAsync(AuthenticationProperties)

Invalide este método para tratar los problemas de desafío 401, si un esquema de autenticación en cuestión trata una interacción de autenticación como parte del flujo de solicitud. como agregar un encabezado de respuesta o cambiar el resultado 401 a 302 de una página de inicio de sesión o una ubicación externa de inicio de sesión.

HandleForbiddenAsync(AuthenticationProperties)

Invalide este método para controlar Prohibido.

HandleForbiddenAsync(ChallengeContext)

Invalide este método para tratar con un desafío prohibido.

HandleRequestAsync()

El código común lo llama una vez después de la inicialización. Si un middleware de autenticación responde directamente a rutas de acceso conocidas específicamente, debe invalidar esta virtual, comparar la ruta de acceso de la solicitud con las rutas de acceso conocidas, proporcionar cualquier información de respuesta según corresponda y true para detener el procesamiento adicional.

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

Invalide este método para tratar los problemas de desafío 401, si un esquema de autenticación en cuestión trata una interacción de autenticación como parte del flujo de solicitud. como agregar un encabezado de respuesta o cambiar el resultado 401 a 302 de una página de inicio de sesión o una ubicación externa de inicio de sesión.

InitializeAsync(AuthenticationScheme, HttpContext)

Inicialice el controlador, resuelva las opciones y validelas.

InitializeAsync(TOptions, HttpContext, ILogger, UrlEncoder)

Se llama a Initialize una vez por solicitud para contextualizar esta instancia con el estado adecuado.

InitializeEventsAsync()

Inicializa el objeto de eventos, al que se llama una vez por solicitud por InitializeAsync(AuthenticationScheme, HttpContext).

InitializeHandlerAsync()

Se llama después de que se hayan inicializado las opciones o eventos para que el controlador termine de inicializarse.

ResolveTarget(String)

Resuelve el esquema al que se reenvía esta operación de autenticación.

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

Se aplica a