AuthenticationHandler<TOptions> Třída

Definice

Názorná 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 možností použitých 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á vystavitele, který by se měl použít při vystavení jakýchkoli deklarací identity.

Clock

ISystemClockZíská .

Context

Získá nebo nastaví HttpContext.

CurrentUri

Získá absolutní aktuální adresu URL.

Events

Obslužná rutina volá metody událostí, které poskytují řízení aplikace v určitých bodech, kde probíhá zpracování. Pokud není zadána výchozí instance je zadána, která nic nedělá, když jsou volána metody.

InitializeResult
Logger

ILoggerZíská .

Options

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

OptionsMonitor

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

OriginalPath

Získá cestu, jak je vidět v middlewaru ověřování.

OriginalPathBase

Získá základ cesty, jak je vidět v ověřovacím middlewaru.

PriorHandler
Request

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

Response

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

Scheme

Získá nebo nastaví asociovaný s touto obslužnou rutinou AuthenticationScheme ověřování.

SignInAccepted
SignOutAccepted
UrlEncoder

UrlEncoderZíská .

Metody

AuthenticateAsync()

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

AuthenticateAsync(AuthenticateContext)
BuildRedirectUri(String)

Vytvoří absolutní adresu URL zadané targetPathadresy URL .

ChallengeAsync(AuthenticationProperties)

Zpochybní aktuální požadavek.

ChallengeAsync(ChallengeContext)
CreateEventsAsync()

Vytvoří novou instanci instance událostí.

FinishResponseAsync()

Háček, který se volá při odeslání odpovědi

ForbidAsync(AuthenticationProperties)

Zakažte aktuální požadavek.

GetDescriptions(DescribeSchemesContext)
HandleAuthenticateAsync()

Umožňuje odvozené typy zpracovávat ověřování.

HandleAuthenticateOnceAsync()

Používá se k zajištění, že handleAuthenticateAsync je vyvolán pouze jednou. Následná volání vrátí stejný výsledek ověření.

HandleAuthenticateOnceSafeAsync()

Používá se k zajištění bezpečného vyvolání handleAuthenticateAsync pouze jednou. Následná volání vrátí stejný výsledek ověřování. Všechny výjimky se převedou na neúspěšný výsledek ověřování obsahující výjimku.

HandleChallengeAsync(AuthenticationProperties)

Tuto metodu přepište, aby se zabývala problémy s 401 výzvami, pokud v rámci toku požadavků řeší příslušné schéma ověřování interakci s ověřováním. (například přidání hlavičky odpovědi nebo změna výsledku 401 na 302 přihlašovací stránky nebo externího přihlašovacího umístění.)

HandleForbiddenAsync(AuthenticationProperties)

Tuto metodu přepište tak, aby zpracovávala Forbid.

HandleForbiddenAsync(ChallengeContext)

Tuto metodu přepište, aby se zabývala výzvou, která je zakázaná.

HandleRequestAsync()

Volá se jednou běžným kódem po inicializaci. Pokud ověřovací middleware reaguje přímo na konkrétní známé cesty, musí tento virtuální počítač přepsat, porovnejte cestu požadavku s jeho známými cestami, podle potřeby zadejte všechny informace o odpovědi a true zastavit další zpracování.

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

Tuto metodu přepište, aby se zabývala problémy s 401 výzvami, pokud v rámci toku požadavků řeší příslušné schéma ověřování interakci s ověřováním. (například přidání hlavičky odpovědi nebo změna výsledku 401 na 302 přihlašovací stránky nebo externího přihlašovacího umístění.)

InitializeAsync(AuthenticationScheme, HttpContext)

Inicializuje obslužnou rutinu, přeloží možnosti a ověří je.

InitializeAsync(TOptions, HttpContext, ILogger, UrlEncoder)

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

InitializeEventsAsync()

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

InitializeHandlerAsync()

Volá se po možnostech nebo událostech inicializována pro obslužnou rutinu, aby se dokončila inicializace samotné.

ResolveTarget(String)

Vyřeší schéma, do kterého se tato operace ověřování přeposílala.

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

Platí pro