Udostępnij za pośrednictwem


AuthenticationHandler<TOptions> Klasa

Definicja

Przesłuchiwane abstrakcje do implementowania 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

Parametry typu

TOptions

Typ opcji używanych do konfigurowania programu obsługi uwierzytelniania.

Dziedziczenie
AuthenticationHandler<TOptions>
Pochodne
Implementuje

Konstruktory

AuthenticationHandler<TOptions>()

Przesłuchiwane abstrakcje do implementowania IAuthenticationHandler.

AuthenticationHandler<TOptions>(IOptionsMonitor<TOptions>, ILoggerFactory, UrlEncoder, ISystemClock)
Przestarzałe.

Inicjuje nowe wystąpienie AuthenticationHandler<TOptions>.

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

Inicjuje nowe wystąpienie AuthenticationHandler<TOptions>.

Właściwości

ChallengeCalled

Przesłuchiwane abstrakcje do implementowania IAuthenticationHandler.

ClaimsIssuer

Pobiera wystawcę, który powinien być używany podczas wydawania oświadczeń.

Clock
Przestarzałe.

Pobiera ISystemClock.

Context

Pobiera lub ustawia HttpContext.

CurrentUri

Pobiera bezwzględny bieżący adres URL.

Events

Procedura obsługi wywołuje metody dla zdarzeń, które dają kontrolę aplikacji w określonych punktach, w których odbywa się przetwarzanie. Jeśli nie podano wystąpienia domyślnego, które nie wykonuje żadnych operacji, gdy metody są wywoływane.

InitializeResult

Przesłuchiwane abstrakcje do implementowania IAuthenticationHandler.

Logger

Pobiera ILogger.

Options

Pobiera lub ustawia opcje skojarzone z tą procedurą obsługi uwierzytelniania.

OptionsMonitor

Pobiera IOptionsMonitor<TOptions> w celu wykrywania zmian w opcjach.

OriginalPath

Pobiera ścieżkę widzianą przez oprogramowanie pośredniczące uwierzytelniania.

OriginalPathBase

Pobiera bazę ścieżki, jak widać w przypadku oprogramowania pośredniczącego uwierzytelniania.

PriorHandler

Przesłuchiwane abstrakcje do implementowania IAuthenticationHandler.

Request

Pobiera HttpRequest skojarzone z bieżącym żądaniem.

Response

Pobiera HttpResponse skojarzone z bieżącym żądaniem.

Scheme

Pobiera lub ustawia AuthenticationScheme skojarzone z tą procedurą obsługi uwierzytelniania.

SignInAccepted

Przesłuchiwane abstrakcje do implementowania IAuthenticationHandler.

SignOutAccepted

Przesłuchiwane abstrakcje do implementowania IAuthenticationHandler.

TimeProvider

Pobiera bieżący czas, głównie na potrzeby testów jednostkowych.

UrlEncoder

Pobiera UrlEncoder.

Metody

AuthenticateAsync()

Uwierzytelnij bieżące żądanie.

AuthenticateAsync(AuthenticateContext)

Przesłuchiwane abstrakcje do implementowania IAuthenticationHandler.

BuildRedirectUri(String)

Tworzy bezwzględny adres URL dla określonego targetPath.

ChallengeAsync(AuthenticationProperties)

Wyśmiej bieżące żądanie.

ChallengeAsync(ChallengeContext)

Przesłuchiwane abstrakcje do implementowania IAuthenticationHandler.

CreateEventsAsync()

Tworzy nowe wystąpienie wystąpienia zdarzeń.

FinishResponseAsync()

Hak, który jest wywoływany, gdy odpowiedź ma zostać wysłana

ForbidAsync(AuthenticationProperties)

Zabronić bieżącego żądania.

GetDescriptions(DescribeSchemesContext)

Przesłuchiwane abstrakcje do implementowania IAuthenticationHandler.

HandleAuthenticateAsync()

Umożliwia typom pochodnym obsługę uwierzytelniania.

HandleAuthenticateOnceAsync()

Służy do zapewnienia, że funkcja HandleAuthenticateAsync jest wywoływana tylko raz. Kolejne wywołania będą zwracać ten sam wynik uwierzytelnienia.

HandleAuthenticateOnceSafeAsync()

Służy do zapewnienia, że funkcja HandleAuthenticateAsync jest wywoływana tylko raz. Kolejne wywołania będą zwracać ten sam wynik uwierzytelniania. Wszelkie wyjątki zostaną przekonwertowane na wynik uwierzytelniania, który zakończył się niepowodzeniem zawierający wyjątek.

HandleChallengeAsync(AuthenticationProperties)

Zastąpij tę metodę, aby poradzić sobie z problemami z wyzwaniem 401, jeśli schemat uwierzytelniania, którego dotyczy problem, dotyczy interakcji z uwierzytelnianiem w ramach przepływu żądań. (na przykład dodanie nagłówka odpowiedzi lub zmiana wyniku 401 na 302 na stronę logowania lub lokalizację logowania zewnętrznego).

HandleForbiddenAsync(AuthenticationProperties)

Zastąp tę metodę, aby obsługiwać metodę Forbid.

HandleForbiddenAsync(ChallengeContext)

Zastąpi tę metodę, aby poradzić sobie z wyzwaniem, które jest zabronione.

HandleRequestAsync()

Wywoływany raz przez wspólny kod po zainicjowaniu. Jeśli oprogramowanie pośredniczące uwierzytelniania odpowiada bezpośrednio na znane ścieżki, musi zastąpić tę wirtualną, porównaj ścieżkę żądania ze znanymi ścieżkami, podaj odpowiednie informacje o odpowiedzi i wartość true, aby zatrzymać dalsze przetwarzanie.

HandleSignInAsync(SignInContext)

Przesłuchiwane abstrakcje do implementowania IAuthenticationHandler.

HandleSignOutAsync(SignOutContext)

Przesłuchiwane abstrakcje do implementowania IAuthenticationHandler.

HandleUnauthorizedAsync(ChallengeContext)

Zastąpij tę metodę, aby poradzić sobie z problemami z wyzwaniem 401, jeśli schemat uwierzytelniania, którego dotyczy problem, dotyczy interakcji z uwierzytelnianiem w ramach przepływu żądań. (na przykład dodanie nagłówka odpowiedzi lub zmiana wyniku 401 na 302 na stronę logowania lub lokalizację logowania zewnętrznego).

InitializeAsync(AuthenticationScheme, HttpContext)

Zainicjuj procedurę obsługi, rozwiąż opcje i zweryfikuj je.

InitializeAsync(TOptions, HttpContext, ILogger, UrlEncoder)

Inicjowanie jest wywoływane raz na żądanie w celu kontekstowania tego wystąpienia z odpowiednim stanem.

InitializeEventsAsync()

Inicjuje obiekt zdarzeń, wywoływany raz na żądanie przez InitializeAsync(AuthenticationScheme, HttpContext).

InitializeHandlerAsync()

Wywołana po zainicjowaniu opcji/zdarzeń została zainicjowana, aby program obsługi zakończył inicjowanie.

ResolveTarget(String)

Rozwiązuje schemat, do którego jest przekazywana ta operacja uwierzytelniania.

ShouldHandleScheme(String, Boolean)

Przesłuchiwane abstrakcje do implementowania IAuthenticationHandler.

SignInAsync(SignInContext)

Przesłuchiwane abstrakcje do implementowania IAuthenticationHandler.

SignOutAsync(SignOutContext)

Przesłuchiwane abstrakcje do implementowania IAuthenticationHandler.

Dotyczy