AuthenticationHandler<TOptions> Klasse

Definition

Namespace:

Microsoft.AspNetCore.Authentication

Assembly:

Microsoft.AspNetCore.Authentication.dll

Paket:

Microsoft.AspNetCore.App.Ref v8.0.0

Eine meinungserprobte 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 ausgestellt werden.
Clock	Veraltet. Ruft das ISystemClock ab.
Context	Ruft den HttpContext ab oder legt diesen fest.
CurrentUri	Ruft die absolute aktuelle URL ab.
Events	Der Handler ruft Methoden für die Ereignisse auf, die der Anwendung die Steuerung an bestimmten Stellen geben, an denen die Verarbeitung stattfindet. Wenn diese Option nicht angegeben wird, wird eine Standardinstanz bereitgestellt, die keine Aktionen ausführt, wenn die Methoden aufgerufen werden.
Logger	Ruft das ILogger ab.
Options	Ruft die Optionen ab, die diesem Authentifizierungshandler zugeordnet sind, oder legt sie fest.
OptionsMonitor	Ruft die IOptionsMonitor<TOptions> ab, um Änderungen an Optionen zu erkennen.
OriginalPath	Ruft den Pfad ab, wie er von der Middleware für die Authentifizierung angezeigt wird.
OriginalPathBase	Ruft die Pfadbasis ab, die von der Authentifizierungs-Middleware erkannt wird.
Request	Ruft die ab, die HttpRequest der aktuellen Anforderung zugeordnet ist.
Response	Ruft die ab, die HttpResponse der aktuellen Anforderung zugeordnet ist.
Scheme	Ruft den AuthenticationScheme mit diesem Authentifizierungshandler zugeordneten Ab oder legt diesen fest.
TimeProvider	Ruft die aktuelle Uhrzeit ab, in erster Linie für Komponententests.
UrlEncoder	Ruft das UrlEncoder ab.

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 instance der ereignisse instance.
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 das gleiche Authentifizierungsergebnis zurück.
HandleAuthenticateOnceSafeAsync()	Wird verwendet, um sicherzustellen, dass HandleAuthenticateAsync nur einmal sicher aufgerufen wird. Die nachfolgenden Aufrufe geben das gleiche Authentifizierungsergebnis zurück. Alle Ausnahmen werden in ein fehlerhaftes Authentifizierungsergebnis konvertiert, das die Ausnahme enthält.
HandleChallengeAsync(AuthenticationProperties)	Überschreiben Sie diese Methode, um Probleme mit 401-Herausforderungen zu behandeln, wenn ein fragliches Authentifizierungsschema eine Authentifizierungsinteraktion als Teil des Anforderungsflusses behandelt. (wie das Hinzufügen eines Antwortheaders oder das Ändern des 401-Ergebnisses einer Anmeldeseite oder eines externen Anmeldeorts in 302.)
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 von aufgerufen wird InitializeAsync(AuthenticationScheme, HttpContext).
InitializeHandlerAsync()	Wird aufgerufen, nachdem Optionen/Ereignisse für den Handler initialisiert wurden, um die Initialisierung abzuschließen.
ResolveTarget(String)	Löst das Schema auf, an das dieser Authentifizierungsvorgang weitergeleitet wird.