CookieAuthenticationOptions クラス

定義

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

コンストラクター

CookieAuthenticationOptions()

既定値で初期化されるオプションのインスタンスを作成します

プロパティ

AccessDeniedPath

AccessDeniedPath プロパティは、ForbidAsync を処理するときにリダイレクト ターゲットのハンドラーによって使用されます。

ClaimsIssuer

作成される要求に使用する発行者を取得または設定します。

(継承元 AuthenticationSchemeOptions)
Cookie

Cookie の作成に使用される設定を決定します。

SameSite では、既定値が Lax に設定されます。 HttpOnly 既定値は true ですSecurePolicy では、既定値が SameAsRequest に設定されます。

CookieDomain
互換性のために残されています。

このプロパティは廃止され、今後のバージョンでは削除される予定です。 推奨される代替手段は次の方法です。 の Cookie 場合は 。

Cookie の作成に使用されるドメインを決定します。 既定で提供されません。

CookieHttpOnly
互換性のために残されています。
互換性のために残されています。

このプロパティは廃止され、今後のバージョンでは削除される予定です。 推奨される代替手段は次の方法です。 の Cookie 場合は 。

ブラウザーでクライアント側 JavaScript から Cookie にアクセスできるようにする必要があるかどうかを決定します。 既定は true です。Cookie は HTTP 要求にのみ渡され、ページ上のスクリプトから使用できないことを意味します。

CookieManager

Cookie を要求から取得したり応答に設定したりするときに使用するコンポーネント。

         既定では ChunkingCookieManager が使用されます。
CookieName
互換性のために残されています。
互換性のために残されています。

このプロパティは廃止され、今後のバージョンでは削除される予定です。 推奨される代替手段は次の方法です。 の Cookie 場合は 。

ID を保持するために使用する Cookie 名を決定します。 既定値は です。AspNetCore.Cookie"。 この値は、AuthenticationScheme の名前を変更する場合に変更する必要があります(特に、システムで Cookie 認証ハンドラーが複数回使用されている場合)。

CookiePath
互換性のために残されています。

このプロパティは廃止され、今後のバージョンでは削除される予定です。 推奨される代替手段は次の方法です。 の Cookie 場合は 。

Cookie の作成に使用されるパスを決定します。 ブラウザーの互換性が最も高い場合、既定値は "/" です。

CookieSecure
互換性のために残されています。

このプロパティは廃止され、今後のバージョンでは削除される予定です。 推奨される代替手段は次の方法です。 の Cookie 場合は 。

Cookie を HTTPS 要求でのみ送信する必要があるかどうかを決定します。 既定は、SignIn を実行するページも HTTPS の場合に、Cookie を HTTPS 要求に制限することです。 HTTPS サインイン ページがあり、サイトの一部が HTTP の場合、この値を変更する必要がある場合があります。

DataProtectionProvider

設定した場合、これはデータ保護のために CookieAuthenticationHandler によって使用されます。

Events

「プロバイダー」は、スタートアップ時にアプリケーションによって作成されたオブジェクトのインスタンスに割り当てることができます。 ハンドラーは、処理が発生している特定の時点でアプリケーション制御を提供するプロバイダーのメソッドを呼び出します。 指定されていない場合、メソッドの呼び出し時に、何もしない既定のインスタンスが提供されます。

EventsType

設定した場合、 は、 プロパティではなく Events インスタンスを取得するためにサービスの種類として使用されます。

(継承元 AuthenticationSchemeOptions)
ExpireTimeSpan

Cookie に格納されている認証チケットが作成された時点から有効な状態を維持する時間を制御します。有効期限情報は保護された Cookie チケットに格納されます。 その理由から、期限切れの Cookie は、ブラウザーで消去された後にサーバーに渡された場合でも無視されます。

これは、 の値とは別に、ブラウザーがクッキーを保持 Expires する期間を指定します。

ForwardAuthenticate

設定されている場合は、このスキームが AuthenticateAsync 呼び出しを転送するターゲット スキームを指定します。 たとえば、Context.AuthenticateAsync("ThisScheme") = > Context.AuthenticateAsync("ForwardAuthenticateValue");転送を無効にし、通常の処理を許可するには、ターゲットを現在のスキームに設定します。

(継承元 AuthenticationSchemeOptions)
ForwardChallenge

設定されている場合は、このスキームが ChallengeAsync 呼び出しを転送するターゲット スキームを指定します。 たとえば、Context.ChallengeAsync("ThisScheme") = > Context.ChallengeAsync("ForwardLengeValue");転送を無効にし、通常の処理を許可するには、ターゲットを現在のスキームに設定します。

(継承元 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

メソッド

Validate()

オプションが有効か確認します。 問題なければ例外をスローする必要があります。

(継承元 AuthenticationSchemeOptions)
Validate(String)

オプションが特定のスキームに対して有効か確認します

(継承元 AuthenticationSchemeOptions)

適用対象