AuthenticationHandler<TOptions> Klasa

Definicja

Uważana abstrakcja na potrzeby implementowania IAuthenticationHandlerelementu .

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>()

Uważana abstrakcja na potrzeby implementowania IAuthenticationHandlerelementu .

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

Inicjuje nowe wystąpienie klasy AuthenticationHandler<TOptions>.

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

Inicjuje nowe wystąpienie klasy AuthenticationHandler<TOptions>.

Właściwości

ChallengeCalled

Uważana abstrakcja na potrzeby implementowania IAuthenticationHandlerelementu .

ClaimsIssuer

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

Clock
Przestarzałe.

Pobiera klasę ISystemClock.

Context

Pobiera lub ustawia wartość HttpContext.

CurrentUri

Pobiera bezwzględny bieżący adres URL.

Events

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

InitializeResult

Uważana abstrakcja na potrzeby implementowania IAuthenticationHandlerelementu .

Logger

Pobiera klasę ILogger.

Options

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

OptionsMonitor

Pobiera element , IOptionsMonitor<TOptions> aby wykryć zmiany w opcjach.

OriginalPath

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

OriginalPathBase

Pobiera bazę ścieżki w sposób widoczny dla oprogramowania pośredniczącego uwierzytelniania.

PriorHandler

Uważana abstrakcja na potrzeby implementowania IAuthenticationHandlerelementu .

Request

Pobiera element HttpRequest skojarzony z bieżącym żądaniem.

Response

Pobiera element HttpResponse skojarzony z bieżącym żądaniem.

Scheme

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

SignInAccepted

Uważana abstrakcja na potrzeby implementowania IAuthenticationHandlerelementu .

SignOutAccepted

Uważana abstrakcja na potrzeby implementowania IAuthenticationHandlerelementu .

TimeProvider

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

UrlEncoder

Pobiera klasę UrlEncoder.

Metody

AuthenticateAsync()

Uwierzytelnij bieżące żądanie.

AuthenticateAsync(AuthenticateContext)

Uważana abstrakcja na potrzeby implementowania IAuthenticationHandlerelementu .

BuildRedirectUri(String)

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

ChallengeAsync(AuthenticationProperties)

Wyzwij bieżące żądanie.

ChallengeAsync(ChallengeContext)

Uważana abstrakcja na potrzeby implementowania IAuthenticationHandlerelementu .

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)

Uważana abstrakcja na potrzeby implementowania IAuthenticationHandlerelementu .

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 zwracają ten sam wynik uwierzytelnienia.

HandleAuthenticateOnceSafeAsync()

Służy do zapewnienia, że protokół HandleAuthenticateAsync jest wywoływany tylko raz bezpiecznie. Kolejne wywołania zwracają ten sam wynik uwierzytelniania. Wszystkie 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 401, jeśli system 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 strony logowania lub lokalizacji logowania zewnętrznego).

HandleForbiddenAsync(AuthenticationProperties)

Zastąp tę metodę do obsługi metody Forbid.

HandleForbiddenAsync(ChallengeContext)

Zastąpij tę metodę, aby rozwiązać problem zabroniony.

HandleRequestAsync()

Wywoływane 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ę maszynę wirtualną, porównaj ścieżkę żądania ze znanymi ścieżkami, podaj odpowiednie informacje o odpowiedzi i wartość true, aby zatrzymać dalsze przetwarzanie.

HandleSignInAsync(SignInContext)

Uważana abstrakcja na potrzeby implementowania IAuthenticationHandlerelementu .

HandleSignOutAsync(SignOutContext)

Uważana abstrakcja na potrzeby implementowania IAuthenticationHandlerelementu .

HandleUnauthorizedAsync(ChallengeContext)

Zastąpij tę metodę, aby poradzić sobie z problemami 401, jeśli system 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 strony logowania lub lokalizacji logowania zewnętrznego).

InitializeAsync(AuthenticationScheme, HttpContext)

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

InitializeAsync(TOptions, HttpContext, ILogger, UrlEncoder)

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

InitializeEventsAsync()

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

InitializeHandlerAsync()

Wywoływane po zainicjowaniu opcji/zdarzeń zostało zainicjowane, aby program obsługi zakończył inicjowanie.

ResolveTarget(String)

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

ShouldHandleScheme(String, Boolean)

Uważana abstrakcja na potrzeby implementowania IAuthenticationHandlerelementu .

SignInAsync(SignInContext)

Uważana abstrakcja na potrzeby implementowania IAuthenticationHandlerelementu .

SignOutAsync(SignOutContext)

Uważana abstrakcja na potrzeby implementowania IAuthenticationHandlerelementu .

Dotyczy