11
11

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?

More than 3 years have passed since last update.

ASP.NET Core MVCのセッションタイムアウトと認証タイムアウト

Posted at

ASP.NET Core 2.1~5.0までは同じみたい。
実際にプログラムで確認したのはASP.NET Core 3.1です。

認証タイムアウト

ASP.NET Core MVCでCookieによる認証の利用及びタイムアウトの設定

1.Startup.csのConfigureServicesに認証サービスを登録する

Startup.cs
//CookieAuthenticationDefaults.AuthenticationSchemeのスキーム名は別の文字に変更することも可能
//例えば:MyLoginScheme
//だが変更され場合は利用する際はスキーム名を変更されたスキーム名と一致する必要があります。
//.AddCookieでは認証用のCookieに関する設定です
services.AddAuthentication(CookieAuthenticationDefaults.AuthenticationScheme)
	.AddCookie(CookieAuthenticationDefaults.AuthenticationScheme, option =>
	 {
         //AuthenticationSchemeという認証スキームの共通設定

         //HttpContext.ChallengeAsync(認証チャレンジ)で認証失敗した場合のリダイレクト先
         //簡単に言うとログインされていない時にログインが必要の機能へアクセスする時のリダイレクト先
	     option.LoginPath = "/LoginController/LoginAction";
         //HttpContext.ForbidAsync(認証されているが、必要な権限がない時の禁止)でのリダイレクト先
         //ログインされている、だがアクセスする機能に必要な権限が足りない時のリダイレクト先
	     option.AccessDeniedPath = "/LoginController/ForbidAction";
         
         //該当スキームのCookie名、デフォルトは.AspNetCore.Cookies
	     option.Cookie.Name = "token";
         //Cookieの中に保存されている認証データの有効期限、ここでは5分以内にサーバーへアクセスがないと認証タイムアウトが発生する
	     option.ExpireTimeSpan = TimeSpan.FromMinutes(5);
         //その他の設定に関しては省略する
	 });

①認証Cookieのタイムアウト設定

option.ExpireTimeSpan = TimeSpan.FromMinutes(5);

認証と禁止の詳細については下記を参照

2.Startup.csのConfigureに認証と認可ミドルウェアを登録する

Startup.cs
app.UseAuthentication();
app.UseAuthorization();

認証ミドルウェアの登録順番には要注意登録順番はここから参照

3.実際の認証処理

例えば「LoginController」に「Login」という認証用アクションがあります

LoginController.cs
[HttpPost]
[AllowAnonymous]
public async Task<ActionResult> Login(string loginId,string loginPW,string ReturnUrl)
{
    //ログインID,パスワードチェック処理省略、ログイン出来ると仮定する
    var claims = new List<Claim>(){
                        new Claim(ClaimTypes.Sid,loginId)
                    };
    var identity = new ClaimsIdentity(claims, authSchema);
    var identityPrincipal = new ClaimsPrincipal(identity);
    
    //認証サービス登録する際に設定したスキームと同じものを設定
    await HttpContext.SignInAsync(CookieAuthenticationDefaults.AuthenticationScheme, identityPrincipal, 
    	new AuthenticationProperties
            {
                //サーバーアクセスによる認証時間を更新する
                AllowRefresh = true,
                //認証の有効期間,認証cookieタイムアウト
                ExpiresUtc = DateTimeOffset.UtcNow.AddMinutes(5),
                //cookieの有効期間を優先かsessionを優先か
                //true:cookieが有効であれば、ブラウザを閉じても再ログインが必要ない
                //false:ブラウザ閉じたら再ログインが必要
                IsPersistent = false,
                //cookieの認証時間
                IssuedUtc = DateTime.UtcNow
            });
            
    return Redirect(ReturnUrl);
}

②認証Cookieのタイムアウト設定
②の設定が①より優先される

ExpiresUtc = DateTimeOffset.UtcNow.AddMinutes(5)

セッションタイムアウト

ASP.NET Core MVCでSessionの利用及びタイムアウトの設定

1.Startup.csのConfigureServicesにセッションサービスを登録する

Startup.cs

services.AddSession(option=>
	{
	    //セッションタイムアウト、5分以上操作がないと
	    //デフォルトタイムアウトは20分
	    option.IdleTimeout = TimeSpan.FromMinutes(5);

	    //option.Cookieに関する設定はセッションのクライアントCookieに当たる
	    //認証Cookieとは別物です。デフォルトCookie名は「.AspNetCore.Session」
	});

2.Startup.csのConfigureにセッションミドルウェアを登録する

Startup.cs
app.UseSession();

認証ミドルウェアの登録順番には要注意登録順番はここから参照

結論

認証Cookieとセッションデータは違う物、セッションが取れない場合を認証されていないと同じ扱いにする際は両方のタイムアウトを必ず同じ設定する必要がある。

1.Cookieによる認証とセッション両方とも起用する際の注意
  • 認証Cookieのタイムアウトとセッションタイムアウトの時間を同じにするのがお勧め
  • 認証Cookieのタイムアウトが長い場合、セッションが切れた際のセッションデータの再構築が必要
2.認証する際に設定されたクレームセットの取得
  • 認証データは直接HttpContext.Userに設定されています
  • HttpContext.User.Identity.IsAuthenticatedで認証済みかを判断できる
  • HttpContext.User.Claimsからはクレーム情報を取得できる
11
11
0

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
11
11

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?