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

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á instanci, která HttpClient se používá ke komunikaci se zprostředkovatelem 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 měl být použit při vystavení 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é poskytují řízení aplikace v určitých bodech, kde probíhá zpracování. Pokud není k dispozici, je zadána výchozí instance, která při zavolání metod neprovede nic.
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 obslužné rutině ověřování. (Zděděno od AuthenticationHandler<TOptions>)
OptionsMonitor	Získá k detekci IOptionsMonitor<TOptions> změn možností. (Zděděno od AuthenticationHandler<TOptions>)
OriginalPath	Získá cestu, jak ji vidí ověřovací middleware. (Zděděno od AuthenticationHandler<TOptions>)
OriginalPathBase	Získá základ cesty, jak je vidět middleware 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	HttpRequest Získá přidružený k aktuálnímu požadavku. (Zděděno od AuthenticationHandler<TOptions>)
Response	HttpResponse Získá přidružený k aktuálnímu požadavku. (Zděděno od AuthenticationHandler<TOptions>)
Scheme	Získá nebo nastaví AuthenticationScheme asciated s touto ověřovací obslužnou rutinou. (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řihlašování. (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, primárně 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 targetPathhodnotu . (Zděděno od AuthenticationHandler<TOptions>)
ChallengeAsync(AuthenticationProperties)	Zpochybte aktuální požadavek. (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ří ze zadaného tokensobjektu AuthenticationTicket .
ExchangeCodeAsync(OAuthCodeExchangeContext)	Vymění autorizační kód pro autorizační token od vzdáleného zprostředkovatele.
FinishResponseAsync()	Hook, který se volá, když se má odeslat odpověď (Zděděno od AuthenticationHandler<TOptions>)
ForbidAsync(AuthenticationProperties)	Zakažte aktuální požadavek. (Zděděno od AuthenticationHandler<TOptions>)
FormatScope()	Naformátujte Scope vlastnost.
FormatScope(IEnumerable<String>)	Naformátuje seznam oborů OAuth.
GenerateCorrelationId(AuthenticationProperties)	Vytvoří soubor cookie obsahující nonce sloužící ke korelaci aktuální žádosti o vzdálené ověření. (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 přepsat tuto metodu pro 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 se vyvolá 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í, že se HandleAuthenticateAsync vyvolá pouze jednou bezpečně. Následující volání vrátí stejný výsledek ověřování. Všechny výjimky se převedou na výsledek neúspěšného ověřování obsahující výjimku. (Zděděno od AuthenticationHandler<TOptions>)
HandleChallengeAsync(AuthenticationProperties)	Přepište tuto metodu tak, aby se vypořádaly s problémy 401, pokud příslušné schéma ověřování v rámci toku žádosti řeší ověřovací interakci. (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řepište tuto metodu pro zpracování zákazu. (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()	Zpracuje 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)	Přepište tuto metodu tak, aby se vypořádaly s problémy 401, pokud příslušné schéma ověřování v rámci toku žádosti řeší ověřovací interakci. (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)	Inicializujte obslužnou rutinu, vyřešte možnosti a ověřte je. (Zděděno od AuthenticationHandler<TOptions>)
InitializeAsync(TOptions, HttpContext, ILogger, UrlEncoder)	Inicializace se volá jednou pro každý požadavek, aby se tato instance do kontextu s odpovídajícím stavem. (Zděděno od AuthenticationHandler<TOptions>)
InitializeEventsAsync()	Inicializuje objekt events, který se volá jednou pro každý požadavek uživatelem 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 vlastní inicializaci. (Zděděno od AuthenticationHandler<TOptions>)
ResolveTarget(String)	Řeší schéma, do kterého se tato operace ověřování předává. (Zděděno od AuthenticationHandler<TOptions>)
ShouldHandleRequestAsync()	Získá hodnotu, která určuje, zda aktuální požadavek na ověření by měl zpracovat .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ěří, jestli aktuální požadavek koreluje s aktuální žádostí o vzdálené ověření. (Zděděno od RemoteAuthenticationHandler<TOptions>)
ValidateCorrelationId(AuthenticationProperties)	Obslužná rutina ověřování, která podporuje OAuth. (Zděděno od RemoteAuthenticationHandler<TOptions>)