AuthenticationHandler<TOptions> Klasse

Definition

Namespace:

Microsoft.AspNetCore.Authentication

Assembly:

Microsoft.AspNetCore.Authentication.dll

Paket:

Microsoft.AspNetCore.App.Ref v8.0.0

Quelle:

AuthenticationHandler.cs

Eine meinungierte Abstraktion für die Implementierung von IAuthenticationHandler.

public abstract class AuthenticationHandler<TOptions> : Microsoft.AspNetCore.Authentication.IAuthenticationHandler where TOptions : AuthenticationSchemeOptions, new()

type AuthenticationHandler<'Options (requires 'Options :> AuthenticationSchemeOptions and 'Options : (new : unit -> 'Options))> = class
    interface IAuthenticationHandler

Public MustInherit Class AuthenticationHandler(Of TOptions)
Implements IAuthenticationHandler

Typparameter

TOptions

Der Typ für die Optionen, die zum Konfigurieren des Authentifizierungshandlers verwendet werden.

Vererbung

Object

AuthenticationHandler<TOptions>

Abgeleitet

Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerHandler

Microsoft.AspNetCore.Authentication.Negotiate.NegotiateHandler

Microsoft.AspNetCore.Authentication.RemoteAuthenticationHandler<TOptions>

Microsoft.AspNetCore.Authentication.SignOutAuthenticationHandler<TOptions>

Implementiert

IAuthenticationHandler

Konstruktoren

AuthenticationHandler<TOptions>(IOptionsMonitor<TOptions>, ILoggerFactory, UrlEncoder)	Initialisiert eine neue Instanz von AuthenticationHandler<TOptions>.
AuthenticationHandler<TOptions>(IOptionsMonitor<TOptions>, ILoggerFactory, UrlEncoder, ISystemClock)	Veraltet. Initialisiert eine neue Instanz von AuthenticationHandler<TOptions>.

Eigenschaften

ClaimsIssuer	Ruft den Aussteller ab, der verwendet werden soll, wenn Ansprüche ausgegeben werden.
Clock	Veraltet. Ruft die ISystemClockab.
Context	Dient zum Abrufen oder Festlegen des HttpContext.
CurrentUri	Ruft die absolute aktuelle URL ab.
Events	Der Handler ruft Methoden für die Ereignisse auf, die dem Anwendungssteuerelement an bestimmten Stellen, an denen die Verarbeitung erfolgt, übergeben. Wenn keine Standardinstanz bereitgestellt wird, wird nichts angegeben, wenn die Methoden aufgerufen werden.
Logger	Ruft die ILoggerab.
Options	Ruft die Optionen ab, die diesem Authentifizierungshandler zugeordnet sind, oder legt diese fest.
OptionsMonitor	Ruft die IOptionsMonitor<TOptions> ab, um Änderungen an Optionen zu erkennen.
OriginalPath	Ruft den Pfad ab, wie von der Authentifizierungs-Middleware gesehen.
OriginalPathBase	Ruft die Pfadbasis ab, wie von der Authentifizierungs-Middleware gesehen.
Request	Ruft die HttpRequest ab, die der aktuellen Anforderung zugeordnet ist.
Response	Ruft die HttpResponse ab, die der aktuellen Anforderung zugeordnet ist.
Scheme	Dient zum Abrufen oder Festlegen des AuthenticationScheme, das diesem Authentifizierungshandler zugeordnet ist.
TimeProvider	Ruft die aktuelle Zeit in erster Linie für Komponententests ab.
UrlEncoder	Ruft die UrlEncoderab.

Methoden

AuthenticateAsync()	Authentifizieren Sie die aktuelle Anforderung.
BuildRedirectUri(String)	Erstellt eine absolute URL für die angegebene targetPath.
ChallengeAsync(AuthenticationProperties)	Fordern Sie die aktuelle Anforderung an.
CreateEventsAsync()	Erstellt eine neue Instanz der Ereignisinstanz.
ForbidAsync(AuthenticationProperties)	Verbieten Sie die aktuelle Anforderung.
HandleAuthenticateAsync()	Ermöglicht abgeleiteten Typen die Authentifizierung zu verarbeiten.
HandleAuthenticateOnceAsync()	Wird verwendet, um sicherzustellen, dass HandleAuthenticateAsync nur einmal aufgerufen wird. Die nachfolgenden Aufrufe geben dasselbe Authentifizierungsergebnis zurück.
HandleAuthenticateOnceSafeAsync()	Wird verwendet, um sicherzustellen, dass HandleAuthenticateAsync nur einmal sicher aufgerufen wird. Die nachfolgenden Aufrufe geben dasselbe Authentifizierungsergebnis zurück. Alle Ausnahmen werden in ein fehlgeschlagenes Authentifizierungsergebnis konvertiert, das die Ausnahme enthält.
HandleChallengeAsync(AuthenticationProperties)	Überschreiben Sie diese Methode, um probleme mit 401-Herausforderungen zu umgehen, wenn ein fragliches Authentifizierungsschema eine Authentifizierungsinteraktion als Teil des Anforderungsflusses behandelt. (wie das Hinzufügen eines Antwortheaders oder das Ändern des Ergebnisses 401 auf 302 einer Anmeldeseite oder eines externen Anmeldespeicherorts.)
HandleForbiddenAsync(AuthenticationProperties)	Überschreiben Sie diese Methode, um Forbid zu behandeln.
InitializeAsync(AuthenticationScheme, HttpContext)	Initialisieren Sie den Handler, lösen Sie die Optionen auf, und überprüfen Sie sie.
InitializeEventsAsync()	Initialisiert das Ereignisobjekt, das einmal pro Anforderung durch InitializeAsync(AuthenticationScheme, HttpContext)aufgerufen wird.
InitializeHandlerAsync()	Wird aufgerufen, nachdem Optionen/Ereignisse für den Handler initialisiert wurden, um die Initialisierung selbst abzuschließen.
ResolveTarget(String)	Löst das Schema auf, an das dieser Authentifizierungsvorgang weitergeleitet wird.