CookieAuthenticationHandler 類別

定義

命名空間:

Microsoft.AspNetCore.Authentication.Cookies

組件:

Microsoft.AspNetCore.Authentication.Cookies.dll

套件:

Microsoft.AspNetCore.App.Ref v8.0.0

來源:

CookieAuthenticationHandler.cs

Cookie 型驗證處理程序的實作。

public class CookieAuthenticationHandler : Microsoft.AspNetCore.Authentication.SignInAuthenticationHandler<Microsoft.AspNetCore.Authentication.Cookies.CookieAuthenticationOptions>

type CookieAuthenticationHandler = class
    inherit SignInAuthenticationHandler<CookieAuthenticationOptions>

Public Class CookieAuthenticationHandler
Inherits SignInAuthenticationHandler(Of CookieAuthenticationOptions)

繼承

Object

AuthenticationHandler<TOptions>

SignOutAuthenticationHandler<TOptions>

SignInAuthenticationHandler<CookieAuthenticationOptions>

CookieAuthenticationHandler

建構函式

CookieAuthenticationHandler(IOptionsMonitor<CookieAuthenticationOptions>, ILoggerFactory, UrlEncoder, ISystemClock)	已淘汰. 初始化 CookieAuthenticationHandler的新實例。
CookieAuthenticationHandler(IOptionsMonitor<CookieAuthenticationOptions>, ILoggerFactory, UrlEncoder)	初始化 CookieAuthenticationHandler的新實例。

屬性

ChallengeCalled	Cookie 型驗證處理程序的實作。 (繼承來源 AuthenticationHandler<TOptions>)
ClaimsIssuer	取得發行任何宣告時應該使用的簽發者。 (繼承來源 AuthenticationHandler<TOptions>)
Clock	已淘汰. 取得 ISystemClock。 (繼承來源 AuthenticationHandler<TOptions>)
Context	取得或設定 HttpContext。 (繼承來源 AuthenticationHandler<TOptions>)
CurrentUri	取得絕對目前的URL。 (繼承來源 AuthenticationHandler<TOptions>)
Events	處理程式會在事件上呼叫方法，以在處理發生時的特定時間點提供應用程控。 如果未提供預設實例，則會在呼叫 方法時執行任何動作。
InitializeResult	Cookie 型驗證處理程序的實作。 (繼承來源 AuthenticationHandler<TOptions>)
Logger	取得 ILogger。 (繼承來源 AuthenticationHandler<TOptions>)
Options	取得或設定與這個驗證處理程式相關聯的選項。 (繼承來源 AuthenticationHandler<TOptions>)
OptionsMonitor	取得 IOptionsMonitor<TOptions>，以偵測選項的變更。 (繼承來源 AuthenticationHandler<TOptions>)
OriginalPath	取得驗證中間件所見的路徑。 (繼承來源 AuthenticationHandler<TOptions>)
OriginalPathBase	取得驗證中間件所見的路徑基底。 (繼承來源 AuthenticationHandler<TOptions>)
PriorHandler	Cookie 型驗證處理程序的實作。 (繼承來源 AuthenticationHandler<TOptions>)
Request	取得與目前要求相關聯的 HttpRequest。 (繼承來源 AuthenticationHandler<TOptions>)
Response	取得與目前要求相關聯的 HttpResponse。 (繼承來源 AuthenticationHandler<TOptions>)
Scheme	取得或設定與此驗證處理程式相關聯的 AuthenticationScheme。 (繼承來源 AuthenticationHandler<TOptions>)
SignInAccepted	Cookie 型驗證處理程序的實作。 (繼承來源 AuthenticationHandler<TOptions>)
SignOutAccepted	Cookie 型驗證處理程序的實作。 (繼承來源 AuthenticationHandler<TOptions>)
TimeProvider	取得目前時間，主要是用於單元測試。 (繼承來源 AuthenticationHandler<TOptions>)
UrlEncoder	取得 UrlEncoder。 (繼承來源 AuthenticationHandler<TOptions>)

方法

AuthenticateAsync()	驗證目前的要求。 (繼承來源 AuthenticationHandler<TOptions>)
AuthenticateAsync(AuthenticateContext)	Cookie 型驗證處理程序的實作。 (繼承來源 AuthenticationHandler<TOptions>)
BuildRedirectUri(String)	建構指定之 targetPath的絕對 URL。 (繼承來源 AuthenticationHandler<TOptions>)
ChallengeAsync(AuthenticationProperties)	挑戰目前的要求。 (繼承來源 AuthenticationHandler<TOptions>)
ChallengeAsync(ChallengeContext)	Cookie 型驗證處理程序的實作。 (繼承來源 AuthenticationHandler<TOptions>)
CreateEventsAsync()	建立事件實例的新實例。
FinishResponseAsync()	即將傳送回應時所呼叫的勾點
ForbidAsync(AuthenticationProperties)	禁止目前的要求。 (繼承來源 AuthenticationHandler<TOptions>)
GetDescriptions(DescribeSchemesContext)	Cookie 型驗證處理程序的實作。 (繼承來源 AuthenticationHandler<TOptions>)
HandleAuthenticateAsync()	允許衍生類型處理驗證。
HandleAuthenticateOnceAsync()	用來確保 HandleAuthenticateAsync 只會叫用一次。 後續呼叫會傳回相同的驗證結果。 (繼承來源 AuthenticationHandler<TOptions>)
HandleAuthenticateOnceSafeAsync()	用來確保 HandleAuthenticateAsync 只會安全地叫用一次。 後續呼叫會傳回相同的驗證結果。 任何例外狀況都會轉換成包含例外狀況的失敗驗證結果。 (繼承來源 AuthenticationHandler<TOptions>)
HandleChallengeAsync(AuthenticationProperties)	覆寫此方法來處理 401 挑戰考慮，如果有問題的驗證配置會處理驗證互動，做為要求流程的一部分。 （例如新增響應標頭，或將 401 結果變更為登入頁面或外部登入位置的 302。
HandleForbiddenAsync(AuthenticationProperties)	覆寫此方法以處理 Forbid。
HandleForbiddenAsync(ChallengeContext)	覆寫此方法以處理禁止的挑戰。 (繼承來源 AuthenticationHandler<TOptions>)
HandleRequestAsync()	初始化之後由一般程式代碼呼叫一次。 如果驗證中間件直接回應必須覆寫此虛擬的特定已知路徑，請比較要求路徑與其已知的路徑、適當地提供任何回應資訊，以及 true 以停止進一步處理。 (繼承來源 AuthenticationHandler<TOptions>)
HandleSignInAsync(ClaimsPrincipal, AuthenticationProperties)	覆寫此方法以處理 SignIn。
HandleSignInAsync(SignInContext)	Cookie 型驗證處理程序的實作。 (繼承來源 AuthenticationHandler<TOptions>)
HandleSignOutAsync(AuthenticationProperties)	覆寫此方法以處理 SignOut。
HandleSignOutAsync(SignOutContext)	Cookie 型驗證處理程序的實作。 (繼承來源 AuthenticationHandler<TOptions>)
HandleUnauthorizedAsync(ChallengeContext)	覆寫此方法來處理 401 挑戰考慮，如果有問題的驗證配置會處理驗證互動，做為要求流程的一部分。 （例如新增響應標頭，或將 401 結果變更為登入頁面或外部登入位置的 302。 (繼承來源 AuthenticationHandler<TOptions>)
InitializeAsync(AuthenticationScheme, HttpContext)	初始化處理程式，解析選項並加以驗證。 (繼承來源 AuthenticationHandler<TOptions>)
InitializeAsync(TOptions, HttpContext, ILogger, UrlEncoder)	每個要求會呼叫初始化一次，以適當狀態將此實例內容化。 (繼承來源 AuthenticationHandler<TOptions>)
InitializeEventsAsync()	初始化事件物件，InitializeAsync(AuthenticationScheme, HttpContext)的每個要求呼叫一次。 (繼承來源 AuthenticationHandler<TOptions>)
InitializeHandlerAsync()	在已初始化選項/事件之後呼叫，處理程式完成初始化本身。
ResolveTarget(String)	解析此驗證作業轉送至的配置。 (繼承來源 AuthenticationHandler<TOptions>)
ShouldHandleScheme(String, Boolean)	Cookie 型驗證處理程序的實作。 (繼承來源 AuthenticationHandler<TOptions>)
SignInAsync(ClaimsPrincipal, AuthenticationProperties)	處理登入。 (繼承來源 SignInAuthenticationHandler<TOptions>)
SignInAsync(SignInContext)	Cookie 型驗證處理程序的實作。 (繼承來源 AuthenticationHandler<TOptions>)
SignOutAsync(AuthenticationProperties)	註銷行為。 (繼承來源 SignOutAuthenticationHandler<TOptions>)
SignOutAsync(SignOutContext)	Cookie 型驗證處理程序的實作。 (繼承來源 AuthenticationHandler<TOptions>)