2017-12-15

改 ASP.NET Identity 2 的 Token 時效

專案對於系統發出給 user 的專用連結(重設密碼、promotion link)有個共通的要求:需要可以指定過期時間。為連結加入時效限制可以加強資訊安全的管控,做法就是將時間 hash 後加入連結中,並在執行連結內容時驗證時間 hash 的有效性,概念並不複雜只是秉持著一貫的理念:站在巨人的肩膀上才能看得更遠。既然 ASP.NET Identity 已經提供的功能就不要自己刻,避免製造出隱藏的難解 bug

雖然 ASP.NET Identity 2 提供了基本功能,重點還是要知道如何應用才能發揮實際效果,今天就來看看可以如何設定 Token 過期時間


預設過期時間

  • 一天
  • source code
    /// <summary>
    ///     Token provider that uses an IDataProtector to generate encrypted tokens based off of the security stamp
    /// </summary>
    public class DataProtectorTokenProvider<TUser, TKey> : IUserTokenProvider<TUser, TKey>
        where TUser : class, IUser<TKey> where TKey : IEquatable<TKey>
    {
        /// <summary>
        ///     Constructor
        /// </summary>
        /// <param name="protector"></param>
        public DataProtectorTokenProvider(IDataProtector protector)
        {
            if (protector == null)
            {
                throw new ArgumentNullException("protector");
            }
            Protector = protector;
            TokenLifespan = TimeSpan.FromDays(1);
        }
    ....
    

    1oneday

修改方式

預 ASP.NET MVC 的 Identity 預設範本為例

  1. 開啟 App_Start --> IdentityConfig.cs

    2identityconfig

  2. 修改 ApplicationUserManager class 的 Create 方法:指定 DataProtectionProvider 的 TokenLifespan
    • 修改前

      3beforechange

    • 修改後:指定 Token 時效為 一個小時
      if (dataProtectionProvider != null)
      {
          manager.UserTokenProvider =
              new DataProtectorTokenProvider<ApplicationUser>(
                  dataProtectionProvider.Create("ASP.NET Identity"))
              {
                  TokenLifespan = TimeSpan.FromHours(1)
              };
      }
      

      4after

實際用法

預 ASP.NET MVC 的 Identity 預設範本為例

  1. Controllers --> AccountController.cs

    5accountcontroller

  2. ForgotPassword 中有使用方式介紹
    • 預設未啟用

      6disable

    • 使用說明
      //依 user id 產生專屬 token
      string code = await UserManager.GeneratePasswordResetTokenAsync(user.Id);
      //使用 user id 及 token 產生 reset password 的連結
      var callbackUrl = Url.Action("ResetPassword", "Account", 
          new { userId = user.Id, code = code }, protocol: Request.Url.Scheme); 
      // 將 reset password email 給 user
      await UserManager.SendEmailAsync(user.Id, 
          "Reset Password", 
          "Please reset your password by clicking <a href=\"" + callbackUrl + "\">here</a>");
      

      7enable

  3. 實際收到的 mail 內容

    8actual

心得

這個 Token 時效設定是個很小、很簡易的設定,只是文件上還是不太足夠,我一直找不到相關官方文獻說明預設值,後來是去翻 source code 才確認是 一天,不過至少官方文件有介紹如何修改設定,還不賴

透過簡單的設定過程就讓對外連結加入時效驗證,相當方便

參考資訊

  1. Email Token Expiring After 15 mins - Asp Identity 2.0 API
  2. ccount Confirmation and Password Recovery with ASP.NET Identity (C#)

2 則留言:

  1. 請問一下永久不失效要如何做?

    回覆刪除
    回覆
    1. 沒有直接設定永久不失效的方式
      不過可以透過將 TokenLifespan 設定為極大數值來達成目的

      刪除