OAuthHandler<TOptions> Klasse

Definition

Namespace:

Microsoft.AspNetCore.Authentication.OAuth

Assembly:

Microsoft.AspNetCore.Authentication.OAuth.dll

Paket:

Microsoft.AspNetCore.App.Ref v8.0.0

Ein Authentifizierungshandler, der OAuth unterstützt.

public class OAuthHandler<TOptions> : Microsoft.AspNetCore.Authentication.RemoteAuthenticationHandler<TOptions> where TOptions : OAuthOptions, new()

type OAuthHandler<'Options (requires 'Options :> OAuthOptions and 'Options : (new : unit -> 'Options))> = class
    inherit RemoteAuthenticationHandler<'Options (requires 'Options :> OAuthOptions and 'Options : (new : unit -> 'Options))>

Public Class OAuthHandler(Of TOptions)
Inherits RemoteAuthenticationHandler(Of TOptions)

Typparameter

TOptions

Der Optionstyp.

Vererbung

Object

AuthenticationHandler<TOptions>

RemoteAuthenticationHandler<TOptions>

OAuthHandler<TOptions>

Abgeleitet

Microsoft.AspNetCore.Authentication.Facebook.FacebookHandler

Microsoft.AspNetCore.Authentication.Google.GoogleHandler

Microsoft.AspNetCore.Authentication.MicrosoftAccount.MicrosoftAccountHandler

Konstruktoren

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

Eigenschaften

Backchannel	Ruft die HttpClient instance ab, die für die Kommunikation mit dem Remoteauthentifizierungsanbieter verwendet wird.
ChallengeCalled	Ein Authentifizierungshandler, der OAuth unterstützt. (Geerbt von AuthenticationHandler<TOptions>)
ClaimsIssuer	Ruft den Aussteller ab, der verwendet werden soll, wenn Ansprüche ausgestellt werden. (Geerbt von AuthenticationHandler<TOptions>)
Clock	Veraltet. Ruft das ISystemClock ab. (Geerbt von AuthenticationHandler<TOptions>)
Context	Ruft den HttpContext ab oder legt diesen fest. (Geerbt von AuthenticationHandler<TOptions>)
CurrentUri	Ruft die absolute aktuelle URL ab. (Geerbt von AuthenticationHandler<TOptions>)
Events	Der Handler ruft Methoden für die Ereignisse auf, die der Anwendung die Kontrolle an bestimmten Stellen geben, an denen die Verarbeitung erfolgt. Wenn diese Option nicht angegeben wird, wird eine Standardinstanz bereitgestellt, die keine Aktionen ausführt, wenn die Methoden aufgerufen werden.
InitializeResult	Ein Authentifizierungshandler, der OAuth unterstützt. (Geerbt von AuthenticationHandler<TOptions>)
Logger	Ruft das ILogger ab. (Geerbt von AuthenticationHandler<TOptions>)
Options	Ruft die Optionen ab, die diesem Authentifizierungshandler zugeordnet sind, oder legt diese fest. (Geerbt von AuthenticationHandler<TOptions>)
OptionsMonitor	Ruft ab, IOptionsMonitor<TOptions> um Änderungen an Optionen zu erkennen. (Geerbt von AuthenticationHandler<TOptions>)
OriginalPath	Ruft den Pfad ab, wie er von der Authentifizierungsmiddleware angezeigt wird. (Geerbt von AuthenticationHandler<TOptions>)
OriginalPathBase	Ruft die Pfadbasis ab, wie sie von der Authentifizierungsmiddleware gesehen wird. (Geerbt von AuthenticationHandler<TOptions>)
PriorHandler	Ein Authentifizierungshandler, der OAuth unterstützt. (Geerbt von AuthenticationHandler<TOptions>)
Request	Ruft die ab, die HttpRequest der aktuellen Anforderung zugeordnet ist. (Geerbt von AuthenticationHandler<TOptions>)
Response	Ruft die ab, die HttpResponse der aktuellen Anforderung zugeordnet ist. (Geerbt von AuthenticationHandler<TOptions>)
Scheme	Ruft den AuthenticationScheme mit diesem Authentifizierungshandler zugeordneten ab oder legt diesen fest. (Geerbt von AuthenticationHandler<TOptions>)
SignInAccepted	Ein Authentifizierungshandler, der OAuth unterstützt. (Geerbt von AuthenticationHandler<TOptions>)
SignInScheme	Das standardmäßig für die Anmeldung verwendete Authentifizierungsschema. (Geerbt von RemoteAuthenticationHandler<TOptions>)
SignOutAccepted	Ein Authentifizierungshandler, der OAuth unterstützt. (Geerbt von AuthenticationHandler<TOptions>)
TimeProvider	Ruft die aktuelle Uhrzeit ab, hauptsächlich für Komponententests. (Geerbt von AuthenticationHandler<TOptions>)
UrlEncoder	Ruft das UrlEncoder ab. (Geerbt von AuthenticationHandler<TOptions>)

Methoden

AuthenticateAsync()	Authentifizieren Sie die aktuelle Anforderung. (Geerbt von AuthenticationHandler<TOptions>)
AuthenticateAsync(AuthenticateContext)	Ein Authentifizierungshandler, der OAuth unterstützt. (Geerbt von AuthenticationHandler<TOptions>)
BuildChallengeUrl(AuthenticationProperties, String)	Erstellt die OAuth-Challenge-URL.
BuildRedirectUri(String)	Erstellt eine absolute URL für die angegebene targetPath. (Geerbt von AuthenticationHandler<TOptions>)
ChallengeAsync(AuthenticationProperties)	Fordern Sie die aktuelle Anforderung an. (Geerbt von AuthenticationHandler<TOptions>)
ChallengeAsync(ChallengeContext)	Ein Authentifizierungshandler, der OAuth unterstützt. (Geerbt von AuthenticationHandler<TOptions>)
CreateEventsAsync()	Erstellt eine neue instance der ereignisse instance.
CreateTicketAsync(ClaimsIdentity, AuthenticationProperties, OAuthTokenResponse)	Erstellt eine AuthenticationTicket aus dem angegebenen tokens.
ExchangeCodeAsync(OAuthCodeExchangeContext)	Tauscht den Autorisierungscode gegen ein Autorisierungstoken vom Remoteanbieter aus.
FinishResponseAsync()	Hook, der aufgerufen wird, wenn die Antwort gesendet wird (Geerbt von AuthenticationHandler<TOptions>)
ForbidAsync(AuthenticationProperties)	Verbieten Sie die aktuelle Anforderung. (Geerbt von AuthenticationHandler<TOptions>)
FormatScope()	Formatieren Sie die Scope Eigenschaft.
FormatScope(IEnumerable<String>)	Formatieren Sie eine Liste von OAuth-Bereichen.
GenerateCorrelationId(AuthenticationProperties)	Erzeugt ein Cookie, das eine Nonce enthält, die zum Korrelieren der aktuellen Remoteauthentifizierungsanforderung verwendet wird. (Geerbt von RemoteAuthenticationHandler<TOptions>)
GenerateCorrelationId(AuthenticationProperties)	Ein Authentifizierungshandler, der OAuth unterstützt. (Geerbt von RemoteAuthenticationHandler<TOptions>)
GetDescriptions(DescribeSchemesContext)	Ein Authentifizierungshandler, der OAuth unterstützt. (Geerbt von AuthenticationHandler<TOptions>)
HandleAccessDeniedErrorAsync(AuthenticationProperties)	Abgeleitete Typen können diese Methode außer Kraft setzen, um Fehler mit Zugriff verweigert zu behandeln. (Geerbt von RemoteAuthenticationHandler<TOptions>)
HandleAuthenticateAsync()	Ermöglicht abgeleiteten Typen, die Authentifizierung zu verarbeiten. (Geerbt von RemoteAuthenticationHandler<TOptions>)
HandleAuthenticateOnceAsync()	Wird verwendet, um sicherzustellen, dass HandleAuthenticateAsync nur einmal aufgerufen wird. Die nachfolgenden Aufrufe geben das gleiche Authentifizierungsergebnis zurück. (Geerbt von AuthenticationHandler<TOptions>)
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 fehlgeschlagenes Authentifizierungsergebnis konvertiert, das die Ausnahme enthält. (Geerbt von AuthenticationHandler<TOptions>)
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. (Geerbt von RemoteAuthenticationHandler<TOptions>)
HandleForbiddenAsync(ChallengeContext)	Ein Authentifizierungshandler, der OAuth unterstützt. (Geerbt von RemoteAuthenticationHandler<TOptions>)
HandleRemoteAuthenticateAsync()	Authentifizieren Sie die Benutzeridentität beim Identitätsanbieter. Die -Methode verarbeitet die Anforderung auf dem durch CallbackPath definierten Endpunkt.
HandleRemoteCallbackAsync()	Ein Authentifizierungshandler, der OAuth unterstützt. (Geerbt von RemoteAuthenticationHandler<TOptions>)
HandleRequestAsync()	Verarbeitet die aktuelle Authentifizierungsanforderung. (Geerbt von RemoteAuthenticationHandler<TOptions>)
HandleSignInAsync(SignInContext)	Ein Authentifizierungshandler, der OAuth unterstützt. (Geerbt von RemoteAuthenticationHandler<TOptions>)
HandleSignOutAsync(SignOutContext)	Ein Authentifizierungshandler, der OAuth unterstützt. (Geerbt von RemoteAuthenticationHandler<TOptions>)
HandleUnauthorizedAsync(ChallengeContext)	Ü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.) (Geerbt von AuthenticationHandler<TOptions>)
InitializeAsync(AuthenticationScheme, HttpContext)	Initialisieren Sie den Handler, lösen Sie die Optionen auf, und überprüfen Sie sie. (Geerbt von AuthenticationHandler<TOptions>)
InitializeAsync(TOptions, HttpContext, ILogger, UrlEncoder)	Initialize wird einmal pro Anforderung aufgerufen, um diesen instance mit dem entsprechenden Zustand zu kontextualisieren. (Geerbt von AuthenticationHandler<TOptions>)
InitializeEventsAsync()	Initialisiert das Ereignisobjekt, das einmal pro Anforderung von aufgerufen wird InitializeAsync(AuthenticationScheme, HttpContext). (Geerbt von AuthenticationHandler<TOptions>)
InitializeHandlerAsync()	Wird aufgerufen, nachdem Optionen/Ereignisse initialisiert wurden, damit der Handler die Initialisierung abgeschlossen hat. (Geerbt von AuthenticationHandler<TOptions>)
ResolveTarget(String)	Löst das Schema auf, an das dieser Authentifizierungsvorgang weitergeleitet wird. (Geerbt von AuthenticationHandler<TOptions>)
ShouldHandleRequestAsync()	Ruft einen Wert ab, der bestimmt, ob die aktuelle Authentifizierungsanforderung von HandleRequestAsync()verarbeitet werden soll. (Geerbt von RemoteAuthenticationHandler<TOptions>)
ShouldHandleScheme(String, Boolean)	Ein Authentifizierungshandler, der OAuth unterstützt. (Geerbt von AuthenticationHandler<TOptions>)
SignInAsync(SignInContext)	Ein Authentifizierungshandler, der OAuth unterstützt. (Geerbt von AuthenticationHandler<TOptions>)
SignOutAsync(SignOutContext)	Ein Authentifizierungshandler, der OAuth unterstützt. (Geerbt von AuthenticationHandler<TOptions>)
ValidateCorrelationId(AuthenticationProperties)	Überprüft, ob die aktuelle Anforderung mit der aktuellen Remoteauthentifizierungsanforderung korreliert. (Geerbt von RemoteAuthenticationHandler<TOptions>)
ValidateCorrelationId(AuthenticationProperties)	Ein Authentifizierungshandler, der OAuth unterstützt. (Geerbt von RemoteAuthenticationHandler<TOptions>)