Asp.Net Core Identity隱私數據保護的實現方法

這篇文章給大家分享的是有關Asp.Net Core Identity隱私數據保護的實現方法的內容。小編覺得挺實用的，因此分享給大家做個參考，一起跟隨小編過來看看吧。

前言

Asp.Net Core Identity 是Asp.Net Core 的重要組成部分，他為 Asp.Net Core 甚至其他 .Net Core 應用程序提供了一個簡單易用且易于擴展的基礎用戶管理系統框架。它包含了基本的用戶、角色、第三方登錄、Claim等功能，使用 Identity Server 4 可以為其輕松擴展 OpenId connection 和 Oauth 2.0 相關功能。網上已經有大量相關文章介紹，不過這還不是 Asp.Net Core Identity 的全部，其中一個就是隱私數據保護。

正文

乍一看，隱私數據保護是個什么東西，感覺好像知道，但又說不清楚。確實這個東西光說很難解釋清楚，那就直接上圖：

這是用戶表的一部分，有沒有發現問題所在？用戶名和 Email 字段變成了一堆看不懂的東西。仔細看會發現這串亂碼好像還有點規律：guid + 冒號 +貌似是 base64 編碼的字符串，當然這串字符串去在線解碼結果還是一堆亂碼，比如 id 為 1 的 UserName ：svBqhhluYZSiPZVUF4baOQ== 在線解碼后是²ðj?na”¢=?T?Ú9 。

這就是隱私數據保護，如果沒有這個功能，那么用戶名是明文存儲的，雖然密碼依然是hash難以破解，但如果被拖庫，用戶數據也會面臨更大的風險。因為很多人喜歡在不同的網站使用相同的賬號信息進行注冊，避免遺忘。如果某個網站的密碼被盜，其他網站被拖庫，黑客就可以比對是否有相同的用戶名，嘗試撞庫，甚至如果 Email 被盜，黑客還可以看著 Email 用找回密碼把賬號給 NTR 了。而隱私數據保護就是一層更堅實的后盾，哪怕被拖庫，黑客依然看不懂里面的東西。

然后是這個格式，基本能想到，冒號應該是分隔符，前面一個 guid，后面是加密后的內容。那問題就變成了 guid 又是干嘛的？直接把加密的內容存進去不就完了。這其實是微軟開發框架注重細節的最佳體現，接下來結合代碼就能一探究竟。

啟用隱私數據保護

 //注冊Identity服務（使用EF存儲，在EF上下文之后注冊）
services.AddIdentity<ApplicationUser, ApplicationRole>(options =>
{
 //...
 options.Stores.ProtectPersonalData = true; //在這里啟用隱私數據保護
})
//...
.AddPersonalDataProtection<AesProtector, AesProtectorKeyRing>(); //在這里配置數據加密器，一旦啟用保護，這里必須配置，否則拋出異常

其中的AesProtector 和AesProtectorKeyRing 需要自行實現，微軟并沒有提供現成的類，至少我沒有找到，估計也是這個功能冷門的原因吧。.Neter 都被微軟給慣壞了，都是衣來伸手飯來張口。有沒有發現AesProtectorKeyRing 中有KeyRing 字樣？鑰匙串，恭喜你猜對了，guid 就是這個鑰匙串中一把鑰匙的編號。也就是說如果加密的鑰匙被盜，但不是全部被盜，那用戶信息還不會全部泄露。微軟這一手可真是狠啊！

接下來看看這兩個類是什么吧。

AesProtector 是 ILookupProtector 的實現。接口包含兩個方法，分別用于加密和解密，返回字符串，參數包含字符串數據和上面那個 guid，當然實際只要是字符串就行， guid 是我個人的選擇，生成不重復字符串還是 guid 方便。

AesProtectorKeyRing 則是 ILookupProtectorKeyRing 的實現。接口包含1、獲取當前正在使用的鑰匙編號的只讀屬性，用于提供加密鑰匙；2、根據鑰匙編號獲取字符串的索引器（我這里就是原樣返回的。。。）；3、獲取所有鑰匙編號的方法。

AesProtector

 class AesProtector : ILookupProtector
  {
    private readonly object _locker;

    private readonly Dictionary<string, SecurityUtil.AesProtector> _protectors;

    private readonly DirectoryInfo _dirInfo;

    public AesProtector(IWebHostEnvironment environment)
    {
      _locker = new object();

      _protectors = new Dictionary<string, SecurityUtil.AesProtector>();

      _dirInfo = new DirectoryInfo($@"{environment.ContentRootPath}\App_Data\AesDataProtectionKey");
    }

    public string Protect(string keyId, string data)
    {
      if (data.IsNullOrEmpty())
      {
        return data;
      }

      CheckOrCreateProtector(keyId);

      return _protectors[keyId].Protect(Encoding.UTF8.GetBytes(data)).ToBase64String();
    }

    public string Unprotect(string keyId, string data)
    {
      if (data.IsNullOrEmpty())
      {
        return data;
      }

      CheckOrCreateProtector(keyId);

      return Encoding.UTF8.GetString(_protectors[keyId].Unprotect(data.ToBytesFromBase64String()));
    }

    private void CheckOrCreateProtector(string keyId)
    {
      if (!_protectors.ContainsKey(keyId))
      {
        lock (_locker)
        {
          if (!_protectors.ContainsKey(keyId))
          {
            var fileInfo = _dirInfo.GetFiles().FirstOrDefault(d => d.Name == $@"key-{keyId}.xml") ??
                    throw new FileNotFoundException();
            using (var stream = fileInfo.OpenRead())
            {
              XDocument xmlDoc = XDocument.Load(stream);
              _protectors.Add(keyId,
                new SecurityUtil.AesProtector(xmlDoc.Element("key")?.Element("encryption")?.Element("masterKey")?.Value.ToBytesFromBase64String()
                  , xmlDoc.Element("key")?.Element("encryption")?.Element("iv")?.Value.ToBytesFromBase64String()
                  , int.Parse(xmlDoc.Element("key")?.Element("encryption")?.Attribute("BlockSize")?.Value)
                  , int.Parse(xmlDoc.Element("key")?.Element("encryption")?.Attribute("KeySize")?.Value)
                  , int.Parse(xmlDoc.Element("key")?.Element("encryption")?.Attribute("FeedbackSize")?.Value)
                  , Enum.Parse<PaddingMode>(xmlDoc.Element("key")?.Element("encryption")?.Attribute("Padding")?.Value)
                  , Enum.Parse<CipherMode>(xmlDoc.Element("key")?.Element("encryption")?.Attribute("Mode")?.Value)));
            }
          }
        }
      }
    }
  }

AesProtectorKeyRing

class AesProtectorKeyRing : ILookupProtectorKeyRing
  {
    private readonly object _locker;
    private readonly Dictionary<string, XDocument> _keyRings;
    private readonly DirectoryInfo _dirInfo;

    public AesProtectorKeyRing(IWebHostEnvironment environment)
    {
      _locker = new object();
      _keyRings = new Dictionary<string, XDocument>();
      _dirInfo = new DirectoryInfo($@"{environment.ContentRootPath}\App_Data\AesDataProtectionKey");

      ReadKeys(_dirInfo);
    }

    public IEnumerable<string> GetAllKeyIds()
    {
      return _keyRings.Keys;
    }

    public string CurrentKeyId => NewestActivationKey(DateTimeOffset.Now)?.Element("key")?.Attribute("id")?.Value ?? GenerateKey(_dirInfo)?.Element("key")?.Attribute("id")?.Value;

    public string this[string keyId] =>
      GetAllKeyIds().FirstOrDefault(id => id == keyId) ?? throw new KeyNotFoundException();

    private void ReadKeys(DirectoryInfo dirInfo)
    {
      foreach (var fileInfo in dirInfo.GetFiles().Where(f => f.Extension == ".xml"))
      {
        using (var stream = fileInfo.OpenRead())
        {
          XDocument xmlDoc = XDocument.Load(stream);

          _keyRings.TryAdd(xmlDoc.Element("key")?.Attribute("id")?.Value, xmlDoc);
        }
      }
    }

    private XDocument GenerateKey(DirectoryInfo dirInfo)
    {
      var now = DateTimeOffset.Now;
      if (!_keyRings.Any(item =>
        DateTimeOffset.Parse(item.Value.Element("key")?.Element("activationDate")?.Value) <= now
        && DateTimeOffset.Parse(item.Value.Element("key")?.Element("expirationDate")?.Value) > now))
      {
        lock (_locker)
        {
          if (!_keyRings.Any(item =>
            DateTimeOffset.Parse(item.Value.Element("key")?.Element("activationDate")?.Value) <= now
            && DateTimeOffset.Parse(item.Value.Element("key")?.Element("expirationDate")?.Value) > now))
          {
            var masterKeyId = Guid.NewGuid().ToString();

            XDocument xmlDoc = new XDocument();
            xmlDoc.Declaration = new XDeclaration("1.0", "utf-8", "yes");

            XElement key = new XElement("key");
            key.SetAttributeValue("id", masterKeyId);
            key.SetAttributeValue("version", 1);

            XElement creationDate = new XElement("creationDate");
            creationDate.SetValue(now);

            XElement activationDate = new XElement("activationDate");
            activationDate.SetValue(now);

            XElement expirationDate = new XElement("expirationDate");
            expirationDate.SetValue(now.AddDays(90));

            XElement encryption = new XElement("encryption");
            encryption.SetAttributeValue("BlockSize", 128);
            encryption.SetAttributeValue("KeySize", 256);
            encryption.SetAttributeValue("FeedbackSize", 128);
            encryption.SetAttributeValue("Padding", PaddingMode.PKCS7);
            encryption.SetAttributeValue("Mode", CipherMode.CBC);

            SecurityUtil.AesProtector protector = new SecurityUtil.AesProtector();
            XElement masterKey = new XElement("masterKey");
            masterKey.SetValue(protector.GenerateKey().ToBase64String());

            XElement iv = new XElement("iv");
            iv.SetValue(protector.GenerateIV().ToBase64String());

            xmlDoc.Add(key);
            key.Add(creationDate);
            key.Add(activationDate);
            key.Add(expirationDate);
            key.Add(encryption);
            encryption.Add(masterKey);
            encryption.Add(iv);

            xmlDoc.Save(
              $@"{dirInfo.FullName}\key-{masterKeyId}.xml");

            _keyRings.Add(masterKeyId, xmlDoc);

            return xmlDoc;
          }

          return NewestActivationKey(now);
        }
      }

      return NewestActivationKey(now);
    }

    private XDocument NewestActivationKey(DateTimeOffset now)
    {
      return _keyRings.Where(item =>
          DateTimeOffset.Parse(item.Value.Element("key")?.Element("activationDate")?.Value) <= now
          && DateTimeOffset.Parse(item.Value.Element("key")?.Element("expirationDate")?.Value) > now)
        .OrderByDescending(item =>
          DateTimeOffset.Parse(item.Value.Element("key")?.Element("expirationDate")?.Value)).FirstOrDefault().Value;
    }
  }

這兩個類也是注冊到 Asp.Net Core DI 中的服務，所有 DI 的功能都支持。

在其中我還使用了我在其他地方寫的底層基礎工具類，如果想看完整實現可以去我的 Github 克隆代碼實際運行并體驗。在這里大致說一下這兩個類的設計思路。既然微軟設計了鑰匙串功能，那自然是要利用好。我在代碼里寫死每個鑰匙有效期90天，過期后會自動生成并使用新的鑰匙，鑰匙的詳細信息使用xml文檔保存在項目文件夾中，具體見下面的截圖。Identity 會使用最新鑰匙進行加密并把鑰匙編號一并存入數據庫，在讀取時會根據編號找到對應的加密器解密數據。這個過程由 EF Core 的值轉換器（EF Core 2.1 增加）完成，也就是說 Identity 向 DbContext 中需要加密的字段注冊了值轉換器。所以我也不清楚早期 Identity 有沒有這個功能，不使用 EF Core 的情況下這個功能是否可用。

如果希望對自定義用戶數據進行保護，為對應屬性標注 [PersonalData] 特性即可。Identity 已經對內部的部分屬性進行了標記，比如上面提到的 UserName 。

有幾個要特別注意的點：

1、在有數據的情況下不要隨便開啟或關閉數據保護功能，否則可能導致嚴重后果。

2、鑰匙一定要保護好，保存好。否則可能泄露用戶數據或者再也無法解密用戶數據，從刪庫到跑路那種 Shift + Del 的事千萬別干。

3、被保護的字段無法在數據庫端執行模糊搜索，只能精確匹配。如果希望進行數據分析，只能先用 Identity 把數據讀取到內存才能繼續做其他事。

4、鑰匙的有效期不宜過短，因為在用戶登錄時 Identity 并不知道用戶是什么時候注冊的，應該用哪個鑰匙，所以 Identity 會用所有鑰匙加密一遍然后查找是否有精確匹配的記錄。鑰匙的有效期越短，隨著網站運行時間的增加，鑰匙數量會增加，要嘗試的鑰匙也會跟著增加，最后對系統性能產生影響。當然這可以用緩存來緩解。

效果預覽：

感謝各位的閱讀！關于“Asp.Net Core Identity隱私數據保護的實現方法”這篇文章就分享到這里了，希望以上內容可以對大家有一定的幫助，讓大家可以學到更多知識，如果覺得文章不錯，可以把它分享出去讓更多的人看到吧！