CookieAuthenticationHandler クラス

定義

名前空間:: Microsoft.AspNetCore.Authentication.Cookies

アセンブリ:: Microsoft.AspNetCore.Authentication.Cookies.dll

パッケージ:: Microsoft.AspNetCore.App.Ref v10.0.0

パッケージ:: Microsoft.AspNetCore.App.Ref v11.0.0-rc.2.26504.105

パッケージ:: Microsoft.AspNetCore.Authentication.Cookies v2.0.0

パッケージ:: Microsoft.AspNetCore.Authentication.Cookies v2.1.0

パッケージ:: Microsoft.AspNetCore.Authentication.Cookies v2.2.0

パッケージ:: Microsoft.AspNetCore.App.Ref v3.0.1

パッケージ:: Microsoft.AspNetCore.App.Ref v3.1.10

パッケージ:: Microsoft.AspNetCore.App.Ref v5.0.0

パッケージ:: Microsoft.AspNetCore.App.Ref v6.0.6

パッケージ:: Microsoft.AspNetCore.App.Ref v7.0.5

パッケージ:: Microsoft.AspNetCore.App.Ref v8.0.19

パッケージ:: Microsoft.AspNetCore.App.Ref v9.0.8

ソース:: CookieAuthenticationHandler.cs

ソース:: CookieAuthenticationHandler.cs

ソース:: CookieAuthenticationHandler.cs

重要

一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。

Cookie ベースの認証ハンドラーの実装。

public ref class CookieAuthenticationHandler : Microsoft::AspNetCore::Authentication::AuthenticationHandler<Microsoft::AspNetCore::Authentication::Cookies::CookieAuthenticationOptions ^>, Microsoft::AspNetCore::Authentication::IAuthenticationSignInHandler

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

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

public class CookieAuthenticationHandler : Microsoft.AspNetCore.Authentication.AuthenticationHandler<Microsoft.AspNetCore.Authentication.Cookies.CookieAuthenticationOptions>, Microsoft.AspNetCore.Authentication.IAuthenticationSignInHandler

type CookieAuthenticationHandler = class
    inherit SignInAuthenticationHandler<CookieAuthenticationOptions>

type CookieAuthenticationHandler = class
    inherit AuthenticationHandler<CookieAuthenticationOptions>
    interface IAuthenticationSignInHandler
    interface IAuthenticationSignOutHandler
    interface IAuthenticationHandler

Public Class CookieAuthenticationHandler
Inherits SignInAuthenticationHandler(Of CookieAuthenticationOptions)

Public Class CookieAuthenticationHandler
Inherits AuthenticationHandler(Of CookieAuthenticationOptions)
Implements IAuthenticationSignInHandler

継承: Object

AuthenticationHandler<TOptions>

SignOutAuthenticationHandler<TOptions>

SignInAuthenticationHandler<CookieAuthenticationOptions>
CookieAuthenticationHandler

継承: Object

AuthenticationHandler<CookieAuthenticationOptions>
CookieAuthenticationHandler

実装: IAuthenticationHandler IAuthenticationSignInHandler IAuthenticationSignOutHandler

コンストラクター

Name	説明
CookieAuthenticationHandler(IOptionsMonitor<CookieAuthenticationOptions>, ILoggerFactory, UrlEncoder, ISystemClock)	古い. CookieAuthenticationHandlerの新しいインスタンスを初期化します。
CookieAuthenticationHandler(IOptionsMonitor<CookieAuthenticationOptions>, ILoggerFactory, UrlEncoder)	CookieAuthenticationHandlerの新しいインスタンスを初期化します。

プロパティ

Name	説明
ClaimsIssuer	要求が発行されたときに使用する発行者を取得します。 (継承元 AuthenticationHandler<TOptions>)
Clock	古い. ISystemClock を取得します。 (継承元 AuthenticationHandler<TOptions>)
Context	HttpContext を取得または設定します。 (継承元 AuthenticationHandler<TOptions>)
CurrentUri	現在の絶対 URL を取得します。 (継承元 AuthenticationHandler<TOptions>)
Events	ハンドラーは、処理が発生している特定のポイントでアプリケーション制御を提供するイベントに対してメソッドを呼び出します。指定されていない場合は、メソッドが呼び出されたときに何も行わない既定のインスタンスが提供されます。
Logger	ILogger を取得します。 (継承元 AuthenticationHandler<TOptions>)
Options	この認証ハンドラーに関連付けられているオプションを取得または設定します。 (継承元 AuthenticationHandler<TOptions>)
OptionsMonitor	オプションの変更を検出する IOptionsMonitor<TOptions> を取得します。 (継承元 AuthenticationHandler<TOptions>)
OriginalPath	認証ミドルウェアに表示されるパスを取得します。 (継承元 AuthenticationHandler<TOptions>)
OriginalPathBase	認証ミドルウェアによって表示されるパスベースを取得します。 (継承元 AuthenticationHandler<TOptions>)
Request	現在の要求に関連付けられている HttpRequest を取得します。 (継承元 AuthenticationHandler<TOptions>)
Response	現在の要求に関連付けられている HttpResponse を取得します。 (継承元 AuthenticationHandler<TOptions>)
Scheme	この認証ハンドラーに関連付けられている AuthenticationScheme を取得または設定します。 (継承元 AuthenticationHandler<TOptions>)
TimeProvider	現在の時刻 (主に単体テスト用) を取得します。 (継承元 AuthenticationHandler<TOptions>)
UrlEncoder	UrlEncoder を取得します。 (継承元 AuthenticationHandler<TOptions>)

メソッド

Name	説明
AuthenticateAsync()	現在の要求を認証します。 (継承元 AuthenticationHandler<TOptions>)
BuildRedirectUri(String)	指定した `targetPath`の絶対 URL を構築します。 (継承元 AuthenticationHandler<TOptions>)
ChallengeAsync(AuthenticationProperties)	現在の要求にチャレンジします。 (継承元 AuthenticationHandler<TOptions>)
CreateEventsAsync()	イベントインスタンスの新しいインスタンスを作成します。
FinishResponseAsync()	応答が送信されるときに呼び出されるフック
ForbidAsync(AuthenticationProperties)	現在の要求を禁止します。 (継承元 AuthenticationHandler<TOptions>)
HandleAuthenticateAsync()	派生型が認証を処理できるようにします。
HandleAuthenticateOnceAsync()	HandleAuthenticateAsync が 1 回だけ呼び出されるようにするために使用されます。以降の呼び出しでは、同じ認証結果が返されます。 (継承元 AuthenticationHandler<TOptions>)
HandleAuthenticateOnceSafeAsync()	HandleAuthenticateAsync が安全に 1 回だけ呼び出されるようにするために使用されます。後続の呼び出しでは、同じ認証結果が返されます。例外はすべて、例外を含む失敗した認証結果に変換されます。 (継承元 AuthenticationHandler<TOptions>)
HandleChallengeAsync(AuthenticationProperties)	このメソッドをオーバーライドして、問題の認証スキームが要求フローの一部として認証の相互作用を処理する場合 (応答ヘッダーの追加、ログインページまたは外部サインインの場所の 302 への 401 の結果の変更など) に 401 チャレンジの懸念に対処します。
HandleForbiddenAsync(AuthenticationProperties)	Forbid を処理するには、このメソッドをオーバーライドします。
HandleSignInAsync(ClaimsPrincipal, AuthenticationProperties)	SignIn を処理するには、このメソッドをオーバーライドします。
HandleSignOutAsync(AuthenticationProperties)	SignOut を処理するには、このメソッドをオーバーライドします。
InitializeAsync(AuthenticationScheme, HttpContext)	ハンドラーを初期化し、オプションを解決して検証します。 (継承元 AuthenticationHandler<TOptions>)
InitializeEventsAsync()	InitializeAsync(AuthenticationScheme, HttpContext)によって要求ごとに 1 回呼び出されるイベントオブジェクトを初期化します。 (継承元 AuthenticationHandler<TOptions>)
InitializeHandlerAsync()	ハンドラーが自身の初期化を完了するためにオプション/イベントが初期化された後に呼び出されます。
ResolveTarget(String)	この認証操作が転送されるスキームを解決します。 (継承元 AuthenticationHandler<TOptions>)
SignInAsync(ClaimsPrincipal, AuthenticationProperties)	Cookie ベースの認証ハンドラーの実装。
SignInAsync(ClaimsPrincipal, AuthenticationProperties)	サインインを処理します。 (継承元 SignInAuthenticationHandler<TOptions>)
SignOutAsync(AuthenticationProperties)	Cookie ベースの認証ハンドラーの実装。
SignOutAsync(AuthenticationProperties)	サインアウト動作。 (継承元 SignOutAuthenticationHandler<TOptions>)

適用対象

フィードバック

このページはお役に立ちましたか?