OpenIdConnectHandler Klasse
Definition
Wichtig
Einige Informationen beziehen sich auf Vorabversionen, die vor dem Release ggf. grundlegend überarbeitet werden. Microsoft übernimmt hinsichtlich der hier bereitgestellten Informationen keine Gewährleistungen, seien sie ausdrücklich oder konkludent.
Ein Authentifizierungshandler pro Anforderung für die OpenIdConnectAuthenticationMiddleware.
public ref class OpenIdConnectHandler : Microsoft::AspNetCore::Authentication::RemoteAuthenticationHandler<Microsoft::AspNetCore::Builder::OpenIdConnectOptions ^>
public ref class OpenIdConnectHandler : Microsoft::AspNetCore::Authentication::RemoteAuthenticationHandler<Microsoft::AspNetCore::Authentication::OpenIdConnect::OpenIdConnectOptions ^>, Microsoft::AspNetCore::Authentication::IAuthenticationSignOutHandler
public class OpenIdConnectHandler : Microsoft.AspNetCore.Authentication.RemoteAuthenticationHandler<Microsoft.AspNetCore.Builder.OpenIdConnectOptions>
public class OpenIdConnectHandler : Microsoft.AspNetCore.Authentication.RemoteAuthenticationHandler<Microsoft.AspNetCore.Authentication.OpenIdConnect.OpenIdConnectOptions>, Microsoft.AspNetCore.Authentication.IAuthenticationSignOutHandler
type OpenIdConnectHandler = class
inherit RemoteAuthenticationHandler<OpenIdConnectOptions>
type OpenIdConnectHandler = class
inherit RemoteAuthenticationHandler<OpenIdConnectOptions>
interface IAuthenticationSignOutHandler
interface IAuthenticationHandler
Public Class OpenIdConnectHandler
Inherits RemoteAuthenticationHandler(Of OpenIdConnectOptions)
Public Class OpenIdConnectHandler
Inherits RemoteAuthenticationHandler(Of OpenIdConnectOptions)
Implements IAuthenticationSignOutHandler
- Vererbung
-
OpenIdConnectHandler
- Vererbung
-
OpenIdConnectHandler
- Implementiert
Konstruktoren
| Name | Beschreibung |
|---|---|
| OpenIdConnectHandler(HttpClient, HtmlEncoder) |
Ein Authentifizierungshandler pro Anforderung für die OpenIdConnectAuthenticationMiddleware. |
| OpenIdConnectHandler(IOptionsMonitor<OpenIdConnectOptions>, ILoggerFactory, HtmlEncoder, UrlEncoder, ISystemClock) |
Veraltet.
Initialisiert eine neue instance von OpenIdConnectHandler. |
| OpenIdConnectHandler(IOptionsMonitor<OpenIdConnectOptions>, ILoggerFactory, HtmlEncoder, UrlEncoder) |
Initialisiert eine neue instance von OpenIdConnectHandler. |
Eigenschaften
| Name | Beschreibung |
|---|---|
| Backchannel |
Ruft die verwendung für die HttpClient Kommunikation mit dem Remoteidentitätsanbieter ab. |
| ClaimsIssuer |
Ruft den Aussteller ab, der verwendet werden soll, wenn Ansprüche ausgegeben werden. (Geerbt von AuthenticationHandler<TOptions>) |
| Clock |
Veraltet.
Ruft ISystemClock ab. (Geerbt von AuthenticationHandler<TOptions>) |
| Context |
Ruft ab oder legt die HttpContext. (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 dem Anwendungssteuerelement an bestimmten Stellen, an denen die Verarbeitung erfolgt, übergeben. Wenn keine Standardinstanz bereitgestellt wird, wird nichts angegeben, wenn die Methoden aufgerufen werden. |
| HtmlEncoder |
Ruft HtmlEncoder ab. |
| Logger |
Ruft 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 von der Authentifizierungs-Middleware gesehen. (Geerbt von AuthenticationHandler<TOptions>) |
| OriginalPathBase |
Ruft die Pfadbasis ab, wie von der Authentifizierungs-Middleware gesehen. (Geerbt von AuthenticationHandler<TOptions>) |
| Request |
Ruft die HttpRequest zugeordnete mit der aktuellen Anforderung ab. (Geerbt von AuthenticationHandler<TOptions>) |
| Response |
Ruft die HttpResponse zugeordnete mit der aktuellen Anforderung ab. (Geerbt von AuthenticationHandler<TOptions>) |
| Scheme |
Dient zum Abrufen oder Festlegen des AuthenticationScheme zugeordneten Authentifizierungshandlers. (Geerbt von AuthenticationHandler<TOptions>) |
| SignInScheme |
Das Authentifizierungsschema, das standardmäßig für die Anmeldung verwendet wird. (Geerbt von RemoteAuthenticationHandler<TOptions>) |
| TimeProvider |
Ruft die aktuelle Zeit in erster Linie für Komponententests ab. (Geerbt von AuthenticationHandler<TOptions>) |
| UrlEncoder |
Ruft UrlEncoder ab. (Geerbt von AuthenticationHandler<TOptions>) |
Methoden
| Name | Beschreibung |
|---|---|
| AuthenticateAsync() |
Authentifizieren Sie die aktuelle Anforderung. (Geerbt von AuthenticationHandler<TOptions>) |
| BuildRedirectUri(String) |
Erstellt eine absolute URL für die angegebene |
| ChallengeAsync(AuthenticationProperties) |
Fordern Sie die aktuelle Anforderung an. (Geerbt von AuthenticationHandler<TOptions>) |
| CreateEventsAsync() |
Erstellt eine neue Instanz der Ereignisinstanz. |
| ForbidAsync(AuthenticationProperties) |
Verbieten Sie die aktuelle Anforderung. (Geerbt von AuthenticationHandler<TOptions>) |
| GenerateCorrelationId(AuthenticationProperties) |
Erzeugt ein Cookie, das eine Nonce enthält, die verwendet wird, um die aktuelle Remoteauthentifizierungsanforderung zu korrelieren. (Geerbt von RemoteAuthenticationHandler<TOptions>) |
| GetUserInformationAsync(OpenIdConnectMessage, JwtSecurityToken, AuthenticationTicket) |
Wechselt zum UserInfo-Endpunkt, um zusätzliche Ansprüche abzurufen und alle eindeutigen Ansprüche zur angegebenen Identität hinzuzufügen. |
| GetUserInformationAsync(OpenIdConnectMessage, JwtSecurityToken, ClaimsPrincipal, AuthenticationProperties) |
Wechselt zum UserInfo-Endpunkt, um zusätzliche Ansprüche abzurufen und alle eindeutigen Ansprüche zur angegebenen Identität hinzuzufügen. |
| HandleAccessDeniedErrorAsync(AuthenticationProperties) |
Abgeleitete Typen können diese Methode außer Kraft setzen, um Zugriff verweigerte Fehler 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 dasselbe Authentifizierungsergebnis zurück. (Geerbt von AuthenticationHandler<TOptions>) |
| 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. (Geerbt von AuthenticationHandler<TOptions>) |
| HandleChallengeAsync(AuthenticationProperties) |
Antwortet auf eine 401-Herausforderung. Sendet eine OpenIdConnect-Nachricht an die "Identitätsstelle", um eine Identität abzurufen. |
| HandleForbiddenAsync(AuthenticationProperties) |
Überschreiben Sie diese Methode, um Forbid zu behandeln. (Geerbt von RemoteAuthenticationHandler<TOptions>) |
| HandleRemoteAuthenticateAsync() |
Wird aufgerufen, um eingehende OpenIdConnect-Nachrichten zu verarbeiten. |
| HandleRemoteSignOutAsync() |
Behandelt Remote-Abmeldeanforderungen, die vom Identitätsanbieter gesendet werden. |
| HandleRequestAsync() |
Behandelt die aktuelle Authentifizierungsanforderung. |
| HandleSignOutAsync(SignOutContext) |
Umleiten des Benutzers an den Identitätsanbieter zum Abmelden |
| HandleSignOutCallbackAsync() |
Antwort auf den Rückruf des OpenId-Anbieters nach Beendigung der Sitzung. |
| HandleUnauthorizedAsync(ChallengeContext) |
Antwortet auf eine 401-Herausforderung. Sendet eine OpenIdConnect-Nachricht an die "Identitätsstelle", um eine Identität abzurufen. |
| InitializeAsync(AuthenticationScheme, HttpContext) |
Initialisieren Sie den Handler, lösen Sie die Optionen auf, und überprüfen Sie sie. (Geerbt von AuthenticationHandler<TOptions>) |
| InitializeEventsAsync() |
Initialisiert das Ereignisobjekt, das einmal pro Anforderung aufgerufen wird.InitializeAsync(AuthenticationScheme, HttpContext) (Geerbt von AuthenticationHandler<TOptions>) |
| InitializeHandlerAsync() |
Wird aufgerufen, nachdem Optionen/Ereignisse für den Handler initialisiert wurden, um die Initialisierung selbst abzuschließen. (Geerbt von AuthenticationHandler<TOptions>) |
| RedeemAuthorizationCodeAsync(OpenIdConnectMessage) |
Löst den Autorisierungscode für Token am Tokenendpunkt ein. |
| 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()behandelt werden soll. (Geerbt von RemoteAuthenticationHandler<TOptions>) |
| SignOutAsync(AuthenticationProperties) |
Umleiten des Benutzers an den Identitätsanbieter zum Abmelden |
| ValidateCorrelationId(AuthenticationProperties) |
Überprüft, ob die aktuelle Anforderung mit der aktuellen Remoteauthentifizierungsanforderung korreliert. (Geerbt von RemoteAuthenticationHandler<TOptions>) |