OAuthHandler<TOptions> Třída

Definice

Obor názvů:

Microsoft.AspNetCore.Authentication.OAuth

Sestavení:

Microsoft.AspNetCore.Authentication.OAuth.dll

Balíček:

Microsoft.AspNetCore.App.Ref v8.0.0

Zdroj:

OAuthHandler.cs

Obslužná rutina ověřování, která podporuje OAuth.

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)

Parametry typu

TOptions

Typ možností.

Dědičnost

Object

AuthenticationHandler<TOptions>

RemoteAuthenticationHandler<TOptions>

OAuthHandler<TOptions>

Odvozené

Microsoft.AspNetCore.Authentication.Facebook.FacebookHandler

Microsoft.AspNetCore.Authentication.Google.GoogleHandler

Microsoft.AspNetCore.Authentication.MicrosoftAccount.MicrosoftAccountHandler

Konstruktory

OAuthHandler<TOptions>(IOptionsMonitor<TOptions>, ILoggerFactory, UrlEncoder)	Inicializuje novou instanci OAuthHandler<TOptions>.
OAuthHandler<TOptions>(IOptionsMonitor<TOptions>, ILoggerFactory, UrlEncoder, ISystemClock)	Zastaralé. Inicializuje novou instanci OAuthHandler<TOptions>.

Vlastnosti

Backchannel	Získá HttpClient instanci použitou ke komunikaci s poskytovatelem vzdáleného ověřování.
ChallengeCalled	Obslužná rutina ověřování, která podporuje OAuth. (Zděděno od AuthenticationHandler<TOptions>)
ClaimsIssuer	Získá vystavitele, který by se měl použít při vystavení jakýchkoli deklarací identity. (Zděděno od AuthenticationHandler<TOptions>)
Clock	Zastaralé. Získá ISystemClock. (Zděděno od AuthenticationHandler<TOptions>)
Context	Získá nebo nastaví HttpContext. (Zděděno od AuthenticationHandler<TOptions>)
CurrentUri	Získá absolutní aktuální adresu URL. (Zděděno od AuthenticationHandler<TOptions>)
Events	Obslužná rutina volá metody událostí, které dávají řízení aplikace v určitých bodech, kde probíhá zpracování. Pokud není zadána výchozí instance je zadána, což nic nedělá, když jsou volána metody.
InitializeResult	Obslužná rutina ověřování, která podporuje OAuth. (Zděděno od AuthenticationHandler<TOptions>)
Logger	Získá ILogger. (Zděděno od AuthenticationHandler<TOptions>)
Options	Získá nebo nastaví možnosti přidružené k této ověřovací obslužné rutině. (Zděděno od AuthenticationHandler<TOptions>)
OptionsMonitor	Získá IOptionsMonitor<TOptions> k detekci změn možností. (Zděděno od AuthenticationHandler<TOptions>)
OriginalPath	Získá cestu, jak je vidět v middlewaru ověřování. (Zděděno od AuthenticationHandler<TOptions>)
OriginalPathBase	Získá základ cesty, jak je vidět v middlewaru ověřování. (Zděděno od AuthenticationHandler<TOptions>)
PriorHandler	Obslužná rutina ověřování, která podporuje OAuth. (Zděděno od AuthenticationHandler<TOptions>)
Request	Získá HttpRequest přidružené k aktuálnímu požadavku. (Zděděno od AuthenticationHandler<TOptions>)
Response	Získá HttpResponse přidružené k aktuálnímu požadavku. (Zděděno od AuthenticationHandler<TOptions>)
Scheme	Získá nebo nastaví AuthenticationScheme přidružené k této obslužné rutině ověřování. (Zděděno od AuthenticationHandler<TOptions>)
SignInAccepted	Obslužná rutina ověřování, která podporuje OAuth. (Zděděno od AuthenticationHandler<TOptions>)
SignInScheme	Schéma ověřování používané ve výchozím nastavení pro přihlášení. (Zděděno od RemoteAuthenticationHandler<TOptions>)
SignOutAccepted	Obslužná rutina ověřování, která podporuje OAuth. (Zděděno od AuthenticationHandler<TOptions>)
TimeProvider	Získá aktuální čas, především pro testování jednotek. (Zděděno od AuthenticationHandler<TOptions>)
UrlEncoder	Získá UrlEncoder. (Zděděno od AuthenticationHandler<TOptions>)

Metody

AuthenticateAsync()	Ověřte aktuální požadavek. (Zděděno od AuthenticationHandler<TOptions>)
AuthenticateAsync(AuthenticateContext)	Obslužná rutina ověřování, která podporuje OAuth. (Zděděno od AuthenticationHandler<TOptions>)
BuildChallengeUrl(AuthenticationProperties, String)	Vytvoří adresu URL výzvy OAuth.
BuildRedirectUri(String)	Vytvoří absolutní adresu URL pro zadanou targetPath. (Zděděno od AuthenticationHandler<TOptions>)
ChallengeAsync(AuthenticationProperties)	Zadejte výzvu k aktuálnímu požadavku. (Zděděno od AuthenticationHandler<TOptions>)
ChallengeAsync(ChallengeContext)	Obslužná rutina ověřování, která podporuje OAuth. (Zděděno od AuthenticationHandler<TOptions>)
CreateEventsAsync()	Vytvoří novou instanci instance událostí.
CreateTicketAsync(ClaimsIdentity, AuthenticationProperties, OAuthTokenResponse)	Vytvoří AuthenticationTicket ze zadaného tokens.
ExchangeCodeAsync(OAuthCodeExchangeContext)	Vymění autorizační kód pro autorizační token od vzdáleného poskytovatele.
FinishResponseAsync()	Volání háku, který se volá při odeslání odpovědi (Zděděno od AuthenticationHandler<TOptions>)
ForbidAsync(AuthenticationProperties)	Zakázat aktuální požadavek. (Zděděno od AuthenticationHandler<TOptions>)
FormatScope()	Naformátujte vlastnost Scope.
FormatScope(IEnumerable<String>)	Naformátuje seznam oborů OAuth.
GenerateCorrelationId(AuthenticationProperties)	Vytvoří soubor cookie obsahující nonce použitý ke korelaci aktuální žádosti o vzdálené ověřování. (Zděděno od RemoteAuthenticationHandler<TOptions>)
GenerateCorrelationId(AuthenticationProperties)	Obslužná rutina ověřování, která podporuje OAuth. (Zděděno od RemoteAuthenticationHandler<TOptions>)
GetDescriptions(DescribeSchemesContext)	Obslužná rutina ověřování, která podporuje OAuth. (Zděděno od AuthenticationHandler<TOptions>)
HandleAccessDeniedErrorAsync(AuthenticationProperties)	Odvozené typy mohou tuto metodu přepsat za účelem zpracování chyb odepření přístupu. (Zděděno od RemoteAuthenticationHandler<TOptions>)
HandleAuthenticateAsync()	Umožňuje odvozené typy zpracovávat ověřování. (Zděděno od RemoteAuthenticationHandler<TOptions>)
HandleAuthenticateOnceAsync()	Používá se k zajištění, že HandleAuthenticateAsync je vyvolán pouze jednou. Následující volání vrátí stejný výsledek ověření. (Zděděno od AuthenticationHandler<TOptions>)
HandleAuthenticateOnceSafeAsync()	Používá se k zajištění bezpečného vyvolání handleAuthenticateAsync pouze jednou. Následující volání vrátí stejný výsledek ověřování. Všechny výjimky budou převedeny na neúspěšný výsledek ověřování obsahující výjimku. (Zděděno od AuthenticationHandler<TOptions>)
HandleChallengeAsync(AuthenticationProperties)	Tuto metodu přepište, aby se vyřešila otázka 401 problémů, pokud příslušné schéma ověřování řeší interakci s ověřováním v rámci toku požadavků. (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)	Přepsat tuto metodu pro zpracování Forbid. (Zděděno od RemoteAuthenticationHandler<TOptions>)
HandleForbiddenAsync(ChallengeContext)	Obslužná rutina ověřování, která podporuje OAuth. (Zděděno od RemoteAuthenticationHandler<TOptions>)
HandleRemoteAuthenticateAsync()	Ověřte identitu uživatele pomocí zprostředkovatele identity. Metoda zpracuje požadavek na koncový bod definovaný metodou CallbackPath.
HandleRemoteCallbackAsync()	Obslužná rutina ověřování, která podporuje OAuth. (Zděděno od RemoteAuthenticationHandler<TOptions>)
HandleRequestAsync()	Zpracovává aktuální požadavek na ověření. (Zděděno od RemoteAuthenticationHandler<TOptions>)
HandleSignInAsync(SignInContext)	Obslužná rutina ověřování, která podporuje OAuth. (Zděděno od RemoteAuthenticationHandler<TOptions>)
HandleSignOutAsync(SignOutContext)	Obslužná rutina ověřování, která podporuje OAuth. (Zděděno od RemoteAuthenticationHandler<TOptions>)
HandleUnauthorizedAsync(ChallengeContext)	Tuto metodu přepište, aby se vyřešila otázka 401 problémů, pokud příslušné schéma ověřování řeší interakci s ověřováním v rámci toku požadavků. (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í.) (Zděděno od AuthenticationHandler<TOptions>)
InitializeAsync(AuthenticationScheme, HttpContext)	Inicializace obslužné rutiny, vyřešení možností a jejich ověření. (Zděděno od AuthenticationHandler<TOptions>)
InitializeAsync(TOptions, HttpContext, ILogger, UrlEncoder)	Inicializace se volá jednou za požadavek pro kontextalizaci této instance s odpovídajícím stavem. (Zděděno od AuthenticationHandler<TOptions>)
InitializeEventsAsync()	Inicializuje objekt událostí, volaných jednou na požadavek InitializeAsync(AuthenticationScheme, HttpContext). (Zděděno od AuthenticationHandler<TOptions>)
InitializeHandlerAsync()	Volá se po inicializaci možností nebo událostí, aby obslužná rutina dokončila inicializaci sama. (Zděděno od AuthenticationHandler<TOptions>)
ResolveTarget(String)	Vyřeší schéma, na které se tato ověřovací operace přepošla. (Zděděno od AuthenticationHandler<TOptions>)
ShouldHandleRequestAsync()	Získá hodnotu, která určuje, zda aktuální žádost o ověření by měla být zpracována HandleRequestAsync(). (Zděděno od RemoteAuthenticationHandler<TOptions>)
ShouldHandleScheme(String, Boolean)	Obslužná rutina ověřování, která podporuje OAuth. (Zděděno od AuthenticationHandler<TOptions>)
SignInAsync(SignInContext)	Obslužná rutina ověřování, která podporuje OAuth. (Zděděno od AuthenticationHandler<TOptions>)
SignOutAsync(SignOutContext)	Obslužná rutina ověřování, která podporuje OAuth. (Zděděno od AuthenticationHandler<TOptions>)
ValidateCorrelationId(AuthenticationProperties)	Ověří, že aktuální požadavek koreluje s aktuální žádostí o vzdálené ověřování. (Zděděno od RemoteAuthenticationHandler<TOptions>)
ValidateCorrelationId(AuthenticationProperties)	Obslužná rutina ověřování, která podporuje OAuth. (Zděděno od RemoteAuthenticationHandler<TOptions>)