OAuthHandler<TOptions> Kelas

Definisi

Ruang nama:

Microsoft.AspNetCore.Authentication.OAuth

Rakitan:

Microsoft.AspNetCore.Authentication.OAuth.dll

Paket:

Microsoft.AspNetCore.App.Ref v8.0.0

Sumber:

OAuthHandler.cs

Handler autentikasi yang mendukung 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)

Jenis parameter

TOptions

Jenis opsi.

Warisan

Object

AuthenticationHandler<TOptions>

RemoteAuthenticationHandler<TOptions>

OAuthHandler<TOptions>

Turunan

Microsoft.AspNetCore.Authentication.Facebook.FacebookHandler

Microsoft.AspNetCore.Authentication.Google.GoogleHandler

Microsoft.AspNetCore.Authentication.MicrosoftAccount.MicrosoftAccountHandler

Konstruktor

OAuthHandler<TOptions>(IOptionsMonitor<TOptions>, ILoggerFactory, UrlEncoder, ISystemClock)	Kedaluwarsa. Menginisialisasi instans baru OAuthHandler<TOptions>.
OAuthHandler<TOptions>(IOptionsMonitor<TOptions>, ILoggerFactory, UrlEncoder)	Menginisialisasi instans baru OAuthHandler<TOptions>.

Properti

Backchannel	Mendapatkan instans HttpClient yang digunakan untuk berkomunikasi dengan penyedia autentikasi jarak jauh.
ChallengeCalled	Handler autentikasi yang mendukung OAuth. (Diperoleh dari AuthenticationHandler<TOptions>)
ClaimsIssuer	Mendapatkan pengeluar sertifikat yang harus digunakan ketika klaim apa pun dikeluarkan. (Diperoleh dari AuthenticationHandler<TOptions>)
Clock	Kedaluwarsa. Mendapatkan ISystemClock. (Diperoleh dari AuthenticationHandler<TOptions>)
Context	Mendapatkan atau mengatur HttpContext. (Diperoleh dari AuthenticationHandler<TOptions>)
CurrentUri	Mendapatkan url absolut saat ini. (Diperoleh dari AuthenticationHandler<TOptions>)
Events	Handler memanggil metode pada peristiwa yang memberikan kontrol aplikasi pada titik-titik tertentu di mana pemrosesan terjadi. Jika tidak disediakan, instans default disediakan yang tidak melakukan apa pun ketika metode dipanggil.
InitializeResult	Handler autentikasi yang mendukung OAuth. (Diperoleh dari AuthenticationHandler<TOptions>)
Logger	Mendapatkan ILogger. (Diperoleh dari AuthenticationHandler<TOptions>)
Options	Mendapatkan atau mengatur opsi yang terkait dengan handler autentikasi ini. (Diperoleh dari AuthenticationHandler<TOptions>)
OptionsMonitor	Mendapatkan IOptionsMonitor<TOptions> untuk mendeteksi perubahan pada opsi. (Diperoleh dari AuthenticationHandler<TOptions>)
OriginalPath	Mendapatkan jalur seperti yang terlihat oleh middleware autentikasi. (Diperoleh dari AuthenticationHandler<TOptions>)
OriginalPathBase	Mendapatkan basis jalur seperti yang terlihat oleh middleware autentikasi. (Diperoleh dari AuthenticationHandler<TOptions>)
PriorHandler	Handler autentikasi yang mendukung OAuth. (Diperoleh dari AuthenticationHandler<TOptions>)
Request	Mendapatkan HttpRequest yang terkait dengan permintaan saat ini. (Diperoleh dari AuthenticationHandler<TOptions>)
Response	Mendapatkan HttpResponse yang terkait dengan permintaan saat ini. (Diperoleh dari AuthenticationHandler<TOptions>)
Scheme	Mendapatkan atau mengatur AuthenticationScheme yang terkait dengan handler autentikasi ini. (Diperoleh dari AuthenticationHandler<TOptions>)
SignInAccepted	Handler autentikasi yang mendukung OAuth. (Diperoleh dari AuthenticationHandler<TOptions>)
SignInScheme	Skema autentikasi yang digunakan secara default untuk masuk. (Diperoleh dari RemoteAuthenticationHandler<TOptions>)
SignOutAccepted	Handler autentikasi yang mendukung OAuth. (Diperoleh dari AuthenticationHandler<TOptions>)
TimeProvider	Mendapatkan waktu saat ini, terutama untuk pengujian unit. (Diperoleh dari AuthenticationHandler<TOptions>)
UrlEncoder	Mendapatkan UrlEncoder. (Diperoleh dari AuthenticationHandler<TOptions>)

Metode

AuthenticateAsync()	Autentikasi permintaan saat ini. (Diperoleh dari AuthenticationHandler<TOptions>)
AuthenticateAsync(AuthenticateContext)	Handler autentikasi yang mendukung OAuth. (Diperoleh dari AuthenticationHandler<TOptions>)
BuildChallengeUrl(AuthenticationProperties, String)	Membuat url tantangan OAuth.
BuildRedirectUri(String)	Membuat url absolut untuk targetPathyang ditentukan. (Diperoleh dari AuthenticationHandler<TOptions>)
ChallengeAsync(AuthenticationProperties)	Tantang permintaan saat ini. (Diperoleh dari AuthenticationHandler<TOptions>)
ChallengeAsync(ChallengeContext)	Handler autentikasi yang mendukung OAuth. (Diperoleh dari AuthenticationHandler<TOptions>)
CreateEventsAsync()	Membuat instans baru instans peristiwa.
CreateTicketAsync(ClaimsIdentity, AuthenticationProperties, OAuthTokenResponse)	Membuat AuthenticationTicket dari tokensyang ditentukan.
ExchangeCodeAsync(OAuthCodeExchangeContext)	Menukar kode otorisasi untuk token otorisasi dari penyedia jarak jauh.
FinishResponseAsync()	Hook yang dipanggil ketika respons akan dikirim (Diperoleh dari AuthenticationHandler<TOptions>)
ForbidAsync(AuthenticationProperties)	Melarang permintaan saat ini. (Diperoleh dari AuthenticationHandler<TOptions>)
FormatScope()	Format properti Scope.
FormatScope(IEnumerable<String>)	Format daftar cakupan OAuth.
GenerateCorrelationId(AuthenticationProperties)	Menghasilkan cookie yang berisi nonce yang digunakan untuk menghubungkan permintaan autentikasi jarak jauh saat ini. (Diperoleh dari RemoteAuthenticationHandler<TOptions>)
GenerateCorrelationId(AuthenticationProperties)	Handler autentikasi yang mendukung OAuth. (Diperoleh dari RemoteAuthenticationHandler<TOptions>)
GetDescriptions(DescribeSchemesContext)	Handler autentikasi yang mendukung OAuth. (Diperoleh dari AuthenticationHandler<TOptions>)
HandleAccessDeniedErrorAsync(AuthenticationProperties)	Jenis turunan dapat mengambil alih metode ini untuk menangani kesalahan akses yang ditolak. (Diperoleh dari RemoteAuthenticationHandler<TOptions>)
HandleAuthenticateAsync()	Memungkinkan jenis turunan untuk menangani autentikasi. (Diperoleh dari RemoteAuthenticationHandler<TOptions>)
HandleAuthenticateOnceAsync()	Digunakan untuk memastikan HandleAuthenticateAsync hanya dipanggil sekali. Panggilan berikutnya akan mengembalikan hasil autentikasi yang sama. (Diperoleh dari AuthenticationHandler<TOptions>)
HandleAuthenticateOnceSafeAsync()	Digunakan untuk memastikan HandleAuthenticateAsync hanya dipanggil setelah aman. Panggilan berikutnya akan mengembalikan hasil autentikasi yang sama. Setiap pengecualian akan dikonversi menjadi hasil autentikasi yang gagal yang berisi pengecualian. (Diperoleh dari AuthenticationHandler<TOptions>)
HandleChallengeAsync(AuthenticationProperties)	Ambil alih metode ini untuk menangani masalah tantangan 401, jika skema autentikasi yang dimaksud menangani interaksi autentikasi sebagai bagian dari alur permintaannya. (seperti menambahkan header respons, atau mengubah hasil 401 menjadi 302 halaman masuk atau lokasi masuk eksternal.)
HandleForbiddenAsync(AuthenticationProperties)	Ambil alih metode ini untuk menangani Terlarang. (Diperoleh dari RemoteAuthenticationHandler<TOptions>)
HandleForbiddenAsync(ChallengeContext)	Handler autentikasi yang mendukung OAuth. (Diperoleh dari RemoteAuthenticationHandler<TOptions>)
HandleRemoteAuthenticateAsync()	Autentikasi identitas pengguna dengan idP. Metode memproses permintaan pada titik akhir yang ditentukan oleh CallbackPath.
HandleRemoteCallbackAsync()	Handler autentikasi yang mendukung OAuth. (Diperoleh dari RemoteAuthenticationHandler<TOptions>)
HandleRequestAsync()	Menangani permintaan autentikasi saat ini. (Diperoleh dari RemoteAuthenticationHandler<TOptions>)
HandleSignInAsync(SignInContext)	Handler autentikasi yang mendukung OAuth. (Diperoleh dari RemoteAuthenticationHandler<TOptions>)
HandleSignOutAsync(SignOutContext)	Handler autentikasi yang mendukung OAuth. (Diperoleh dari RemoteAuthenticationHandler<TOptions>)
HandleUnauthorizedAsync(ChallengeContext)	Ambil alih metode ini untuk menangani masalah tantangan 401, jika skema autentikasi yang dimaksud menangani interaksi autentikasi sebagai bagian dari alur permintaannya. (seperti menambahkan header respons, atau mengubah hasil 401 menjadi 302 halaman masuk atau lokasi masuk eksternal.) (Diperoleh dari AuthenticationHandler<TOptions>)
InitializeAsync(AuthenticationScheme, HttpContext)	Inisialisasi handler, atasi opsi dan validasi. (Diperoleh dari AuthenticationHandler<TOptions>)
InitializeAsync(TOptions, HttpContext, ILogger, UrlEncoder)	Inisialisasi dipanggil sekali per permintaan untuk mengonteksualisasi instans ini dengan status yang sesuai. (Diperoleh dari AuthenticationHandler<TOptions>)
InitializeEventsAsync()	Menginisialisasi objek peristiwa, yang dipanggil sekali per permintaan dengan InitializeAsync(AuthenticationScheme, HttpContext). (Diperoleh dari AuthenticationHandler<TOptions>)
InitializeHandlerAsync()	Dipanggil setelah opsi/peristiwa telah diinisialisasi agar handler selesai menginisialisasi dirinya sendiri. (Diperoleh dari AuthenticationHandler<TOptions>)
ResolveTarget(String)	Menyelesaikan skema tempat operasi autentikasi ini diteruskan. (Diperoleh dari AuthenticationHandler<TOptions>)
ShouldHandleRequestAsync()	Mendapatkan nilai yang menentukan apakah permintaan autentikasi saat ini harus ditangani oleh HandleRequestAsync(). (Diperoleh dari RemoteAuthenticationHandler<TOptions>)
ShouldHandleScheme(String, Boolean)	Handler autentikasi yang mendukung OAuth. (Diperoleh dari AuthenticationHandler<TOptions>)
SignInAsync(SignInContext)	Handler autentikasi yang mendukung OAuth. (Diperoleh dari AuthenticationHandler<TOptions>)
SignOutAsync(SignOutContext)	Handler autentikasi yang mendukung OAuth. (Diperoleh dari AuthenticationHandler<TOptions>)
ValidateCorrelationId(AuthenticationProperties)	Memvalidasi bahwa permintaan saat ini berkorelasi dengan permintaan autentikasi jarak jauh saat ini. (Diperoleh dari RemoteAuthenticationHandler<TOptions>)
ValidateCorrelationId(AuthenticationProperties)	Handler autentikasi yang mendukung OAuth. (Diperoleh dari RemoteAuthenticationHandler<TOptions>)