ASP.Net Mvc實現自定義User Identity用戶身份識別系統（2）

上一篇博文中已經實現瞭如何在頁面上使用自定義的屬性即上篇博文所示的@this.U,今天將進一步研究用戶自定義User Identity; 實現思路：通過研究微軟自帶identity的套路，我們可以發現其實現此功能的介面為IIdentity、System.Security.Principal.IPr ...

上一篇博文中已經實現瞭如何在頁面上使用自定義的屬性即上篇博文所示的@this.U,今天將進一步研究用戶自定義User Identity;

實現思路：

通過研究微軟自帶identity的套路，我們可以發現其實現此功能的介面為IIdentity、System.Security.Principal.IPrincipal，（源碼將會在後面展示），因此，第一步，我們需要創建繼承IIdentity、System.Security.Principal.IPrincipal的實現類；UTIdentity.cs，UTPrincipal.cs;第二步，當我們定義好屬於自己項目的身份識別的類之後，此時我們需要對我們定義的類初始化賦值，而初始化數據來源則應該從當前項目cookie中獲取。第三步，根據第二步要求的數據來源要求，系統則需要保存用戶登錄信息到cookie之中。第四步：使用自定義用戶身份識別系統。

總結：

整個程式則需要實現定義類繼承相關介面>>>>>>實現登錄保存Cookie信息>>>>>從cookie中獲取登錄信息，進行相應解密並將其對定義的類進行初始化>>>>>>使用自定義identity。下文將會貼出相應代碼以及相應步驟的完善。

具體步驟：

基於上一篇博文的項目，我們將進行以下操作

1、創建驗證類庫項目

2、在nuget安裝NewtonSoft.Json插件

3、創建用戶信息基本類UserData，UTIdentity，UTPrincipal

 1 using System;
 2 using System.Collections.Generic;
 3 using System.Linq;
 4 using System.Text;
 5 using System.Threading.Tasks;
 6 
 7 namespace Auth
 8 {
 9     public class UserData
10     {
11         /// <summary>
12         /// 用戶id
13         /// </summary>
14         public string UserId { get; set; }
15         /// <summary>
16         /// 昵稱
17         /// </summary>
18         public string NickName { get; set; }
19 
20         /// <summary>
21         /// 登錄名
22         /// </summary>
23         public string LoginName { get; set; }
24         /// <summary>
25         /// 角色id
26         /// </summary>
27         public string RoleId { get; set; }
28         /// <summary>
29         /// 角色名稱
30         /// </summary>
31         public string RoleName { get; set; }
32     }
33 }

  1 using System;
  2 using System.Collections.Generic;
  3 using System.Linq;
  4 using System.Security.Principal;
  5 using System.Text;
  6 using System.Threading.Tasks;
  7 using System.Web;
  8 using System.Web.Security;
  9 
 10 namespace Auth
 11 {
 12     public class UTIdentity: IIdentity
 13     {
 14         /// <summary>
 15         /// forms 身份驗證票據
 16         /// </summary>
 17         private FormsAuthenticationTicket ticket;
 18         /// <summary>
 19         /// http請求連接
 20         /// </summary>
 21         private HttpContext context = HttpContext.Current;
 22         /// <summary>
 23         /// 用戶基本信息
 24         /// </summary>
 25         private UserData _userData;
 26         #region Property
 27         /// <summary>
 28         /// 認證方式
 29         /// </summary>
 30         public string AuthenticationType
 31         {
 32             get { return "Forms"; }
 33         }
 34         /// <summary>
 35         /// 名稱(登錄名）
 36         /// </summary>
 37         public string Name
 38         {
 39             get { return _userData.LoginName; }
 40         }
 41         /// <summary>
 42         /// 登錄名稱
 43         /// </summary>
 44         public string loginname
 45         {
 46             get { return _userData.LoginName; }
 47         }
 48         /// <summary>
 49         /// 通過驗證
 50         /// </summary>
 51         public bool IsAuthenticated
 52         {
 53             get { return true; }
 54         }
 55         /// <summary>
 56         /// 用戶Cookie數據
 57         /// </summary>
 58         public UserData UserData
 59         {
 60             get { return _userData; }
 61         }
 62         /// <summary>
 63         /// 用戶ID
 64         /// </summary>
 65         public string UserId
 66         {
 67             get { return _userData.UserId; }
 68         }
 69         private string mIP = "";
 70         /// <summary>
 71         /// 用戶IP
 72         /// </summary>
 73         public string IP
 74         {
 75             get
 76             {
 77                 if (string.IsNullOrEmpty(context.Request.UserHostAddress))
 78                 {
 79                     try
 80                     {
 81                         mIP = context.Request.UserHostAddress;
 82                     }
 83                     catch { }
 84                 }
 85                 return mIP;
 86             }
 87         }
 88         /// <summary>
 89         /// 是否是管理員
 90         /// </summary>
 91         public bool IsAdmin
 92         {
 93             get { return 1 > 0; }
 94         }
 95         /// <summary>
 96         /// 用戶姓名
 97         /// </summary>
 98         public string UserName { get; private set; }
 99         /// <summary>
100         /// 部門
101         /// </summary>
102         public string RoleName { get; private set; }
103         #endregion
104 
105         public UTIdentity(FormsAuthenticationTicket ticket)
106         {
107             _userData = (UserData)Newtonsoft.Json.JsonConvert.DeserializeObject(ticket.UserData, typeof(UserData));
108             this.ticket = ticket;
109             this.RoleName = _userData.RoleName;
110             this.UserName = _userData.LoginName;
111         }
112     }
113 }

 1 using System;
 2 using System.Collections.Generic;
 3 using System.Linq;
 4 using System.Text;
 5 using System.Threading.Tasks;
 6 using System.Web.Security;
 7 
 8 namespace Auth
 9 {
10     public  class UTPrincipal: System.Security.Principal.IPrincipal
11     {
12         /// <summary>
13         /// 構造函數
14         /// </summary>
15         /// <param name="ticket"></param>
16         public UTPrincipal(FormsAuthenticationTicket ticket)
17         {
18             Identity = new UTIdentity(ticket);
19         }
20         /// <summary>
21         /// 身份信息
22         /// </summary>
23         public UTIdentity Identity
24         {
25             get;
26             private set;
27         }
28         /// <summary>
29         /// 返回身份信息
30         /// </summary>
31         System.Security.Principal.IIdentity System.Security.Principal.IPrincipal.Identity
32         {
33             get { return Identity; }
34         }
35 
36         public bool IsInRole(string role)
37         {
38             throw new NotImplementedException();
39         }
40     }
41 }

4、創建cookie讀寫操作工具類 CookieUtils

  1 using Newtonsoft.Json;
  2 using System;
  3 using System.Collections.Generic;
  4 using System.Linq;
  5 using System.Text;
  6 using System.Threading.Tasks;
  7 using System.Web;
  8 using System.Web.Security;
  9 
 10 namespace Auth
 11 {
 12     public class CookieUtils
 13     {
 14         public static string SYSTEMLOGINCOOKIEKEY = "SYSTEMLOGINCOOKIEKEY";
 15         /// <summary>
 16         /// 取得Cookie登錄信息
 17         /// </summary>
 18         public static UserData GetLoginCookieInfo()
 19         {
 20             UserData ret = null; ;
 21             var cookie = HttpContext.Current.Request.Cookies[SYSTEMLOGINCOOKIEKEY];
 22             if (cookie != null && !string.IsNullOrEmpty(cookie.Value))
 23             {
 24                 try
 25                 {
 26                     var ticket = FormsAuthentication.Decrypt(cookie.Value);
 27                     ret = (UserData)JsonConvert.DeserializeObject(ticket != null ? ticket.UserData : "", typeof(UserData));
 28                 }
 29                 catch
 30                 {
 31 
 32                 }
 33             }
 34             return ret;
 35         }
 36 
 37         public static void SaveLoginCookieInfo(UserData userData)
 38         {
 39             var json = JsonConvert.SerializeObject(userData, Formatting.None,
 40                       new JsonSerializerSettings()
 41                       {
 42                           ReferenceLoopHandling = ReferenceLoopHandling.Ignore
 43                       });
 44 
 45             FormsAuthenticationTicket ticket = new FormsAuthenticationTicket(1, userData.LoginName, DateTime.Now, DateTime.Now.AddMinutes(60), false, json);
 46             //數據加密
 47             string enyTicket = FormsAuthentication.Encrypt(ticket);
 48             HttpCookie cookie = new HttpCookie(SYSTEMLOGINCOOKIEKEY, enyTicket);
 49             HttpContext.Current.Response.Cookies.Add(cookie);
 50         }
 51 
 52         public static void RemoveAuthCookie(UTPrincipal principal)
 53         {
 54             HttpCookie removeCookie;
 55             string cookieName;
 56             int limit = HttpContext.Current.Request.Cookies.Count;
 57             for (int i = 0; i < limit; i++)
 58             {
 59                 cookieName = HttpContext.Current.Request.Cookies[i].Name;
 60                 if (cookieName == SYSTEMLOGINCOOKIEKEY) continue;
 61                 if (!cookieName.Equals(FormsAuthentication.FormsCookieName, StringComparison.OrdinalIgnoreCase))
 62                 {
 63                     continue;
 64                 }
 65                 removeCookie = new HttpCookie(cookieName);
 66                 removeCookie.Expires = DateTime.Now.AddDays(-1);
 67                 HttpContext.Current.Response.Cookies.Add(removeCookie);
 68             }
 69             if (principal != null)
 70             {
 71                 // FuncCodeMapStore.Remove(principal.Identity.userid);
 72             }
 73             HttpContext.Current.Session.Abandon();
 74         }
 75 
 76         /// <summary>
 77         /// 設置Cookie
 78         /// </summary>
 79         /// <param name="loginname">用戶名</param>
 80         /// <param name="userData">用戶數據</param>
 81         /// <param name="rememberMe">記住</param>
 82         public static HttpCookie SetAuthCookie(string loginname, UserData userData, bool rememberMe)
 83         {
 84             if (userData == null)
 85             {
 86                 throw new ArgumentNullException("userData");
 87             }
 88             string _userdata = JsonConvert.SerializeObject(userData, Formatting.None,
 89                         new JsonSerializerSettings()
 90                         {
 91                             ReferenceLoopHandling = ReferenceLoopHandling.Ignore
 92                         });
 93 
 94             //創建ticket
 95             var ticket = new FormsAuthenticationTicket(
 96                 1, loginname, DateTime.Now, DateTime.Now.AddDays(1), rememberMe, _userdata);
 97 
 98             //加密ticket
 99             var cookieValue = FormsAuthentication.Encrypt(ticket);
100 
101             //創建Cookie
102             var cookie = new HttpCookie(FormsAuthentication.FormsCookieName, cookieValue)
103             {
104                 HttpOnly = true,
105                 Domain = FormsAuthentication.CookieDomain,
106                 Path = FormsAuthentication.FormsCookiePath
107             };
108             if (rememberMe)
109                 cookie.Expires = DateTime.Now.AddDays(1);
110 
111             //寫入Cookie
112             HttpContext.Current.Response.Cookies.Remove(cookie.Name);
113             HttpContext.Current.Response.Cookies.Add(cookie);
114 
115             //  Medicom.Common.Log.Info(loginname + " 登錄");
116             var user = HttpContext.Current.User;
117             return cookie;
118         }
119 
120         /// <summary>
121         /// 解析身份認證信息
122         /// </summary>
123         /// <param name="request">http請求對象</param>
124         /// <returns>身份認證信息</returns>
125         public static UTPrincipal TryParsePrincipal(HttpRequest request)
126         {
127             if (request == null)
128                 throw new ArgumentNullException("request");
129 
130             try
131             {
132                 var cookie = request.Cookies[FormsAuthentication.FormsCookieName];
133                 if (cookie == null)
134                 {
135                     return null;
136                 }
137 
138                 var ticket = FormsAuthentication.Decrypt(cookie.Value);
139                 if (ticket != null)
140                 {
141                     UTPrincipal myPrincipal = new UTPrincipal(ticket);
142                     return new UTPrincipal(ticket);
143                 }
144             }
145             catch (Exception e)
146             {
147                 // Medicom.Common.Log.Error("解析登錄信息錯誤：", e);
148             }
149             return null;
150         }
151     }
152 }

5、設置application.Web 配置文件web.config(非視圖配置文件)表單驗證。

 1  <system.web>
 2     <authentication mode="None" />
 3     <compilation debug="true" targetFramework="4.5.2" />
 4     <httpRuntime targetFramework="4.5.2" />
 5     <httpModules>
 6       <add name="ApplicationInsightsWebTracking" type="Microsoft.ApplicationInsights.Web.ApplicationInsightsHttpModule, Microsoft.AI.Web" />
 7     </httpModules>
 8   </system.web>
 9   <system.webServer>
10     <modules>
11       <remove name="FormsAuthentication" />
12       <remove name="ApplicationInsightsWebTracking" />
13       <add name="ApplicationInsightsWebTracking" type="Microsoft.ApplicationInsights.Web.ApplicationInsightsHttpModule, Microsoft.AI.Web" preCondition="managedHandler" />
14     </modules>
15     <validation validateIntegratedModeConfiguration="false" />
16   </system.webServer>

6.在WebViewPage 定義用戶信息實體類

 1 using System;
 2 using System.Collections.Generic;
 3 using System.Linq;
 4 using System.Web;
 5 using System.Web.Mvc;
 6 
 7 namespace Application.Web.Mvc
 8 {
 9     [ValidateInput(false)]
10     public abstract class WebViewPage<TModel> : System.Web.Mvc.WebViewPage<TModel>
11     {
12         public string U = "1111";
13         public new Auth.UTPrincipal User
14         {
15             get
16             {
17                 if (base.User == null)
18                 {
19                     return null;
20                 }
21                 if (base.User.GetType() != typeof(Auth.UTPrincipal))
22                 {
23                     return null;
24                 }
25                 return (Auth.UTPrincipal)base.User;
26             }
27         }
28     }
29     [ValidateInput(false)]
30     public abstract class WebViewPage : System.Web.Mvc.WebViewPage<dynamic>
31     {
32 
33     }
34 }

7、創建BaseController控制器，項目其他控制器均繼承於此控制器類（此處定義user屬性，便於自定義所存儲的用戶信息可在後臺控制器層使用）

 1 using Auth;
 2 using System;
 3 using System.Collections.Generic;
 4 using System.Linq;
 5 using System.Web;
 6 using System.Web.Mvc;
 7 
 8 namespace Application.Web.Controllers
 9 {
10     public class BaseController : Controller
11     {
12         /// <summary>
13         /// 當前用戶信息
14         /// </summary>
15         protected new UTPrincipal User
16         {
17             get
18             {
19                 if (base.User != null && base.User.GetType() == typeof(UTPrincipal))
20                 {
21                     return (UTPrincipal)base.User;
22                 }
23                 return null;
24             }
25         }
26     }
27 }

8、使用表單驗證保存用戶信息

 1  public async Task<ActionResult> Login(LoginViewModel model, string returnUrl)
 2         {
 3             if (!ModelState.IsValid)
 4             {
 5                 return View(model);
 6             } 
 7             var userData = new UserData()
 8             {
 9                 LoginName = model.Email,
10                 RoleName = "測試管理員",
11                 UserId = "1",
12                 NickName = "測試昵稱",
13             };
14             CookieUtils.SaveLoginCookieInfo(userData);
15             CookieUtils.RemoveAuthCookie(this.User);
16             CookieUtils.SetAuthCookie(model.Email, userData, model.RememberMe);
17 
18             if (string.IsNullOrEmpty(returnUrl))
19             {
20                 return RedirectToAction("Index", "Home");
21             }
22 
23             else
24             {
25                 return Redirect(returnUrl);
26             }
27         }

9、在每次請求時在控制器層初始化用戶基本信息並且賦值。便於控制器層能獲取到自定義用戶信息

  protected void Application_PostAuthenticateRequest(object sender, System.EventArgs e)
        {
            HttpContext.Current.SetSessionStateBehavior(SessionStateBehavior.Required);
            var user = Auth.CookieUtils.TryParsePrincipal(HttpContext.Current.Request);
            if (user != null)
            {
                HttpContext.Current.User = user;
            }
        }

測試：

控制器層獲取值

界面獲取值