CookieAuthenticationOptions クラス
定義
重要
一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。
CookieAuthenticationOptionsの構成オプション。
public ref class CookieAuthenticationOptions : Microsoft::AspNetCore::Authentication::AuthenticationSchemeOptions
public class CookieAuthenticationOptions : Microsoft.AspNetCore.Authentication.AuthenticationSchemeOptions
type CookieAuthenticationOptions = class
inherit AuthenticationSchemeOptions
Public Class CookieAuthenticationOptions
Inherits AuthenticationSchemeOptions
- 継承
コンストラクター
| 名前 | 説明 |
|---|---|
| CookieAuthenticationOptions() |
既定値で初期化されたオプションのインスタンスを作成する |
プロパティ
| 名前 | 説明 |
|---|---|
| AccessDeniedPath |
AccessDeniedPath プロパティは、ForbidAsync を処理するときにリダイレクト ターゲットのハンドラーによって使用されます。 |
| ClaimsIssuer |
作成されるすべての要求に使用する発行者を取得または設定します。 (継承元 AuthenticationSchemeOptions) |
| Cookie |
Cookie の作成に使用する設定を決定します。 |
| CookieDomain |
古い.
このプロパティは廃止され、今後のバージョンで削除される予定です。 推奨される代替方法は、<seealso cref="P:Microsoft です。AspNetCore.Http.CookieBuilder.Domain"></seealso> on Cookie。 Cookie の作成に使用するドメインを決定します。 既定では提供されません。 |
| CookieHttpOnly |
古い.
古い.
このプロパティは廃止され、今後のバージョンで削除される予定です。 推奨される代替方法は、<seealso cref="P:Microsoft です。AspNetCore.Http.CookieBuilder.HttpOnly"></seealso> on Cookie。 ブラウザーで、クライアント側の javascript による Cookie へのアクセスを許可するかどうかを決定します。 既定値は true です。つまり、Cookie は http 要求にのみ渡され、ページ上のスクリプトでは使用できません。 |
| CookieManager |
要求から Cookie を取得したり、応答で Cookie を設定したりするために使用されるコンポーネント。 ChunkingCookieManager は既定で使用されます。 |
| CookieName |
古い.
古い.
このプロパティは廃止され、今後のバージョンで削除される予定です。 推奨される代替方法は、<seealso cref="P:Microsoft です。AspNetCore.Http.CookieBuilder.Name"></seealso> on Cookie。 ID の永続化に使用される Cookie 名を決定します。 既定値は ". です。AspNetCore.Cookies"。 この値は、AuthenticationScheme の名前を変更する場合に変更する必要があります。特に、システムが Cookie 認証ハンドラーを複数回使用する場合です。 |
| CookiePath |
古い.
このプロパティは廃止され、今後のバージョンで削除される予定です。 推奨される代替方法は、<seealso cref="P:Microsoft です。AspNetCore.Http.CookieBuilder.Path"></seealso> on Cookie。 Cookie の作成に使用するパスを決定します。 ブラウザーの互換性が最も高い場合、既定値は "/" です。 |
| CookieSecure |
古い.
このプロパティは廃止され、今後のバージョンで削除される予定です。 推奨される代替方法は、<seealso cref="P:Microsoft です。AspNetCore.Http.CookieBuilder.SecurePolicy"></seealso> on Cookie。 Cookie を HTTPS 要求でのみ送信するかどうかを決定します。 既定では、SignIn を実行しているページも HTTPS である場合は、Cookie を HTTPS 要求に制限します。 HTTPS サインイン ページがあり、サイトの一部が HTTP である場合は、この値を変更する必要があります。 |
| DataProtectionProvider |
設定した場合、これはデータ保護のために CookieAuthenticationHandler によって使用されます。 |
| Events |
プロバイダーは、起動時にアプリケーションによって作成されたオブジェクトのインスタンスに割り当てることができます。 ハンドラーは、処理が発生している特定のポイントでアプリケーション制御を提供するプロバイダーのメソッドを呼び出します。 指定されていない場合は、メソッドが呼び出されたときに何も行わない既定のインスタンスが提供されます。 |
| EventsType |
設定されている場合は、サービスの種類として使用され、プロパティの代わりに Events インスタンスが取得されます。 (継承元 AuthenticationSchemeOptions) |
| ExpireTimeSpan |
Cookie に格納されている認証チケットが作成された時点から有効なままになる時間を制御します。 有効期限情報は、保護された Cookie チケットに格納されます。 そのため、有効期限が切れた Cookie は、ブラウザーが削除した後にサーバーに渡された場合でも無視されます。 このプロパティは、 Expirationの代わりに使用する必要があります。これは無視されます。 |
| ForwardAuthenticate |
設定されている場合、このスキームが AuthenticateAsync 呼び出しを転送するターゲット スキームを指定します。 たとえば、Context.AuthenticateAsync("ThisScheme") => Context.AuthenticateAsync("ForwardAuthenticateValue");転送を無効にし、通常の処理を許可するには、ターゲットを現在のスキームに設定します。 (継承元 AuthenticationSchemeOptions) |
| ForwardChallenge |
設定されている場合、このスキームが ChallengeAsync 呼び出しを転送するターゲット スキームを指定します。 たとえば、Context.ChallengeAsync("ThisScheme") => Context.ChallengeAsync("ForwardChallengeValue");転送を無効にし、通常の処理を許可するには、ターゲットを現在のスキームに設定します。 (継承元 AuthenticationSchemeOptions) |
| ForwardDefault |
設定した場合、認証ハンドラーが既定ですべての認証操作を転送する既定のスキームを指定します。 既定の転送ロジックでは、最も具体的な ForwardAuthenticate/Challenge/Forbid/SignIn/SignOut 設定が最初に確認され、次に ForwardDefaultSelector、ForwardDefault が確認されます。 最初の null 以外の結果は、転送先のターゲット スキームとして使用されます。 (継承元 AuthenticationSchemeOptions) |
| ForwardDefaultSelector |
認証ハンドラーが既定ですべての認証操作を転送する必要がある、現在の要求の既定のスキームを選択するために使用します。 既定の転送ロジックでは、最も具体的な ForwardAuthenticate/Challenge/Forbid/SignIn/SignOut 設定が最初に確認され、次に ForwardDefaultSelector、ForwardDefault が確認されます。 最初の null 以外の結果は、転送先のターゲット スキームとして使用されます。 (継承元 AuthenticationSchemeOptions) |
| ForwardForbid |
設定されている場合、このスキームで ForbidAsync 呼び出しを転送するターゲット スキームを指定します。 たとえば、Context.ForbidAsync("ThisScheme") => Context.ForbidAsync("ForwardForbidValue");転送を無効にし、通常の処理を許可するには、ターゲットを現在のスキームに設定します。 (継承元 AuthenticationSchemeOptions) |
| ForwardSignIn |
設定した場合、このスキームで SignInAsync 呼び出しを転送するターゲット スキームを指定します。 たとえば、Context.SignInAsync("ThisScheme") => Context.SignInAsync("ForwardSignInValue");転送を無効にし、通常の処理を許可するには、ターゲットを現在のスキームに設定します。 (継承元 AuthenticationSchemeOptions) |
| ForwardSignOut |
設定されている場合、このスキームで SignOutAsync 呼び出しを転送するターゲット スキームを指定します。 たとえば、Context.SignOutAsync("ThisScheme") => Context.SignOutAsync("ForwardSignOutValue");転送を無効にし、通常の処理を許可するには、ターゲットを現在のスキームに設定します。 (継承元 AuthenticationSchemeOptions) |
| LoginPath |
LoginPath プロパティは、ChallengeAsync を処理するときにリダイレクト ターゲットのハンドラーによって使用されます。 ReturnUrlParameter によって名前付けされたクエリ文字列パラメーターとして LoginPath に追加される現在の URL。 LoginPath への要求で新しい SignIn ID が付与されると、ReturnUrlParameter 値を使用してブラウザーを元の URL にリダイレクトします。 |
| LogoutPath |
LogoutPath が指定されている場合、そのパスへの要求は ReturnUrlParameter に基づいてリダイレクトされます。 |
| ReturnUrlParameter |
ReturnUrlParameter は、チャレンジ中にハンドラーによって追加されるクエリ文字列パラメーターの名前を決定します。 これは、アクションの実行後に元の URL に戻るために、ログイン パスまたはログアウト パスに要求が到着したときに検索されるクエリ文字列パラメーターでもあります。 |
| SessionStore |
要求間で ID を格納する省略可能なコンテナー。 使用すると、セッション識別子のみがクライアントに送信されます。 これは、非常に大きな ID の潜在的な問題を軽減するために使用できます。 |
| SlidingExpiration |
SlidingExpiration は true に設定され、有効期限ウィンドウの半分以上の要求を処理するたびに、新しい有効期限で新しい Cookie を再発行するようにハンドラーに指示します。 |
| TicketDataFormat |
TicketDataFormat は、Cookie 値に格納されている ID やその他のプロパティを保護および保護解除するために使用されます。 指定しない場合は、 DataProtectionProviderを使用して作成されます。 |
| TimeProvider |
テストに使用されます。 (継承元 AuthenticationSchemeOptions) |
メソッド
| 名前 | 説明 |
|---|---|
| Validate() |
オプションが有効であることを確認します。 問題がなければ例外をスローする必要があります。 (継承元 AuthenticationSchemeOptions) |
| Validate(String) |
オプションが特定のスキームに対して有効であることを確認します (継承元 AuthenticationSchemeOptions) |