AuthenticationHandler<TOptions> Třída

Definice

Dogmatickým abstrakce pro implementaci 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 pro možnosti, které se používají ke konfiguraci obslužné rutiny ověřování.

Dědičnost
AuthenticationHandler<TOptions>
Odvozené
Implementuje

Konstruktory

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

Inicializuje novou instanci AuthenticationHandler<TOptions> .

Vlastnosti

ChallengeCalled
ClaimsIssuer

Získá Vystavitel, který by měl být použit při vydání jakékoli deklarace identity.

Clock

Získá ISystemClock .

Context

Získá nebo nastaví HttpContext .

CurrentUri

Načte absolutní aktuální adresu URL.

Events

Obslužná rutina volá metody pro události, které poskytují řízení aplikace v určitých místech, kde dochází ke zpracování. Není-li zadána výchozí instance, která neprovádí žádnou akci při volání metod.

InitializeResult
Logger

Získá ILogger .

Options

Získá nebo nastaví možnosti přidružené k této obslužné rutině ověřování.

OptionsMonitor

Získá IOptionsMonitor<TOptions> a detekuje změny možností.

OriginalPath

Získá cestu, jak se zobrazuje middleware ověřování.

OriginalPathBase

Získá základ cesty, jak je vidět middleware ověřování.

PriorHandler
Request

Získá HttpRequest přidružený k aktuálnímu požadavku.

Response

Získá HttpResponse přidružený k aktuálnímu požadavku.

Scheme

Získá nebo nastaví AuthenticationScheme asssociated pomocí této obslužné rutiny ověřování.

SignInAccepted
SignOutAccepted
UrlEncoder

Získá UrlEncoder .

Metody

AuthenticateAsync()

Ověřte aktuální požadavek.

AuthenticateAsync(AuthenticateContext)
BuildRedirectUri(String)

Vytvoří absolutní adresu URL pro zadaný objekt targetPath .

ChallengeAsync(AuthenticationProperties)

Vyžádá si aktuální požadavek.

ChallengeAsync(ChallengeContext)
CreateEventsAsync()

Vytvoří novou instanci instance Events.

FinishResponseAsync()

Zavěšení, které je voláno při odeslání odpovědi

ForbidAsync(AuthenticationProperties)

Zakažte aktuální požadavek.

GetDescriptions(DescribeSchemesContext)
HandleAuthenticateAsync()

Umožňuje odvozeným typům zpracovat ověřování.

HandleAuthenticateOnceAsync()

Slouží k zajištění, že HandleAuthenticateAsync se vyvolá jenom jednou. Následná volání vrátí stejný výsledek ověřování.

HandleAuthenticateOnceSafeAsync()

Slouží k zajištění, že HandleAuthenticateAsync se vyvolá jenom jednou za bezpečné. Následná volání vrátí stejný výsledek ověřování. Jakékoli výjimky budou převedeny na neúspěšný výsledek ověření obsahující výjimku.

HandleChallengeAsync(AuthenticationProperties)

Tuto metodu přepište, pokud chcete řešit problémy s 401 otázkami, pokud se ve schématu ověřování jedná o interakci ověřování v rámci toku požadavků. (například přidání hlavičky odpovědi nebo změna výsledku 401 na 302 na přihlašovací stránce nebo externím umístění pro přihlášení.)

HandleForbiddenAsync(AuthenticationProperties)

Potlačí tuto metodu pro zpracování nezpracovaných.

HandleForbiddenAsync(ChallengeContext)

Tuto metodu přepište, pokud chcete pracovat s výzvou, která je zakázaná.

HandleRequestAsync()

Volá se jednou běžným kódem po inicializaci. Pokud middleware ověřování reaguje přímo na konkrétně známé cesty, musí přepsat tuto virtuální, porovnat cestu požadavku se známými cestami, poskytnout informace o odpovědi podle potřeby a hodnotu true, která zastaví další zpracování.

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

Tuto metodu přepište, pokud chcete řešit problémy s 401 otázkami, pokud se ve schématu ověřování jedná o interakci ověřování v rámci toku požadavků. (například přidání hlavičky odpovědi nebo změna výsledku 401 na 302 na přihlašovací stránce nebo externím umístění pro přihlášení.)

InitializeAsync(AuthenticationScheme, HttpContext)

Inicializujte obslužnou rutinu, vyřešte možnosti a ověřte je.

InitializeAsync(TOptions, HttpContext, ILogger, UrlEncoder)

Inicializace se volá jednou pro požadavek na dát této instance s odpovídajícím stavem.

InitializeEventsAsync()

Inicializuje objekt událostí, který se volá jednou za požadavek InitializeAsync(AuthenticationScheme, HttpContext) .

InitializeHandlerAsync()

Volá se po inicializaci možností nebo událostí, aby mohla obslužná rutina dokončit inicializaci sama sebe.

ResolveTarget(String)

Vyřeší schéma, na které je tato operace ověřování předána.

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

Platí pro