ASP.NET MVC - 设置自定义 IIdentity 或 IPrincipal

Question

我需要做一些相当简单的事情：在我的 ASP.NET MVC 应用程序中，我想设置一个自定义 IIdentity / IPrincipal。 哪个更容易/更合适。 我想扩展默认值，以便可以调用诸如 User.Identity.Id 和 User.Identity.Role 之类的内容。 没什么特别的，只是一些额外的属性。

我读过大量的文章和问题，但我觉得我让事情变得比实际更难。 我以为这很容易。 如果用户登录，我想设置一个自定义 IIdentity。 所以我想，我将在我的 global.asax 中实现 Application_PostAuthenticateRequest 。 但是，这是在每个请求上调用的，并且我不想在每个请求上调用数据库，这会请求数据库中的所有数据并放入自定义 IPrincipal 对象。 这似乎也非常不必要，缓慢，并且在错误的地方（在那里进行数据库调用），但我可能是错的。 或者这些数据还来自哪里？

所以我想，每当用户登录时，我都可以在会话中添加一些必要的变量，并将其添加到 Application_PostAuthenticateRequest 事件处理程序中的自定义 IIdentity 中。 但是，我的 Context.Session 是 null ，所以这也不是可行的方法。

我已经为此工作了一天，我觉得我错过了一些东西。 这应该不难做到，对吧？ 我也对随之而来的所有（半）相关的东西感到有点困惑。 MembershipProvider、MembershipUser、RoleProvider、ProfileProvider、IPrincipal、IIdentity< /code>, FormsAuthentication...我是唯一一个觉得这一切非常令人困惑的人吗？

如果有人可以告诉我一个简单、优雅且高效的解决方案来在 IIdentity 上存储一些额外的数据，而无需所有额外的模糊......那就太好了！ 我知道也有类似的问题，但如果我需要的答案就在那里，我一定是忽略了。

Answer 1

我不能直接谈论 ASP.NET MVC，但对于 ASP.NET Web 表单，技巧是创建一个 FormsAuthenticationTicket 并在用户通过身份验证后将其加密到 cookie 中。 这样，您只需调用数据库一次（或 AD 或您用于执行身份验证的任何内容），并且每个后续请求都将根据存储在 cookie 中的票证进行身份验证。

关于此的一篇好文章：http:// www.ondotnet.com/pub/a/dotnet/2004/02/02/ effectiveformsauth.html（损坏的链接）

编辑：

由于上面的链接已损坏，我会在上面的回答中推荐 LukeP 的解决方案： https://stackoverflow.com/a/10524305 - 我还建议接受答案改为那个。

编辑2：
损坏链接的替代方法： https://web.archive.org/web/20120422011422/http://ondotnet.com/pub/a/dotnet/2004/02/02/ effectiveformsauth.html

Answer 2

这是完成工作的示例。 bool isValid 通过查看某些数据存储（假设您的用户数据库）来设置。 UserID 只是我维护的一个 ID。 您可以将电子邮件地址等其他信息添加到用户数据中。

protected void btnLogin_Click(object sender, EventArgs e)
{         
    //Hard Coded for the moment
    bool isValid=true;
    if (isValid) 
    {
         string userData = String.Empty;
         userData = userData + "UserID=" + userID;
         FormsAuthenticationTicket ticket = new FormsAuthenticationTicket(1, username, DateTime.Now, DateTime.Now.AddMinutes(30), true, userData);
         string encTicket = FormsAuthentication.Encrypt(ticket);
         HttpCookie faCookie = new HttpCookie(FormsAuthentication.FormsCookieName, encTicket);
         Response.Cookies.Add(faCookie);
         //And send the user where they were heading
         string redirectUrl = FormsAuthentication.GetRedirectUrl(username, false);
         Response.Redirect(redirectUrl);
     }
}

在 golbal asax 中添加以下代码来检索您的信息。

protected void Application_AuthenticateRequest(Object sender, EventArgs e)
{
    HttpCookie authCookie = Request.Cookies[
             FormsAuthentication.FormsCookieName];
    if(authCookie != null)
    {
        //Extract the forms authentication cookie
        FormsAuthenticationTicket authTicket = 
               FormsAuthentication.Decrypt(authCookie.Value);
        // Create an Identity object
        //CustomIdentity implements System.Web.Security.IIdentity
        CustomIdentity id = GetUserIdentity(authTicket.Name);
        //CustomPrincipal implements System.Web.Security.IPrincipal
        CustomPrincipal newUser = new CustomPrincipal();
        Context.User = newUser;
    }
}

当您稍后要使用该信息时，您可以按如下方式访问您的自定义主体。

(CustomPrincipal)this.User
or 
(CustomPrincipal)this.Context.User

这将允许您访问自定义用户信息。

Answer 3

MVC 为您提供了挂在控制器类上的 OnAuthorize 方法。 或者，您可以使用自定义操作过滤器来执行授权。 MVC 使它变得非常容易做到。 我在这里发布了一篇关于此的博客文章。 http://www.bradygaster.com/post/custom-authentication-with -mvc-3.0

Answer 4

如果您需要将某些方法连接到 @User 以在视图中使用，这里有一个解决方案。 没有任何严肃的会员定制的解决方案，但如果原始问题仅需要视图，那么这可能就足够了。 下面的代码用于检查从authorizefilter返回的变量，用于验证是否存在某些链接（不适用于任何类型的授权逻辑或访问授予）。

using System;
    using System.Collections.Generic;
    using System.Linq;
    using System.Web;
    using System.Security.Principal;

    namespace SomeSite.Web.Helpers
    {
        public static class UserHelpers
        {
            public static bool IsEditor(this IPrincipal user)
            {
                return null; //Do some stuff
            }
        }
    }

然后只需在 web.config 区域中添加引用，并在视图中像下面这样调用它。

@User.IsEditor()

Answer 5

基于LukeP的回答，并添加一些方法来设置timeout和requireSSL 与 Web.config 配合。

参考链接

• MSDN，解释：ASP.NET 2.0 中的表单身份验证
• MSDN，FormsAuthentication 类< /a>
• SO，代码中的.net Access Forms 身份验证“超时”值

LukeP修改代码

1、根据Web设置timeout。配置。 FormsAuthentication.Timeout< /a> 将获取超时值，该值在 web.config 中定义。 我将以下内容封装为一个函数，该函数返回一个ticket。

int version = 1;
DateTime now = DateTime.Now;

// respect to the `timeout` in Web.config.
TimeSpan timeout = FormsAuthentication.Timeout;
DateTime expire = now.Add(timeout);
bool isPersist = false;

FormsAuthenticationTicket ticket = new FormsAuthenticationTicket(
     version,          
     name,
     now,
     expire,
     isPersist,
     userData);

2、根据RequireSSL配置，配置cookie是否安全。

HttpCookie faCookie = new HttpCookie(FormsAuthentication.FormsCookieName, encTicket);
// respect to `RequreSSL` in `Web.Config`
bool bSSL = FormsAuthentication.RequireSSL;
faCookie.Secure = bSSL;

Answer 6

如果您想简化页面隐藏代码中的访问，只需将以下代码添加到基页面并在所有页面中派生基页面：

Public Overridable Shadows ReadOnly Property User() As CustomPrincipal
    Get
        Return DirectCast(MyBase.User, CustomPrincipal)
    End Get
End Property

作为 Web 表单用户（而非 MVC）的 LukeP 代码的补充， 您后面的代码可以简单地访问：

User.FirstName or User.LastName

我在 Web 表单场景中缺少的是如何在未绑定到页面的代码中获得相同的行为，例如在 httpmodules 中，我应该始终添加在每个班级中演员，还是有更聪明的方法来获得这个？

感谢您的回答并感谢 LukeP，因为我使用您的示例作为我的自定义用户的基础（现在有 User.Roles、User.Tasks、User .HasPath(int) 、 User.Settings.Timeout 和许多其他好东西）

Answer 7

好吧，所以我是一个严肃的密码管理员，通过拖出这个非常古老的问题，但是有一个更简单的方法来解决这个问题，上面的@Baserz 已经提到了。 那就是使用 C# 扩展方法和缓存的组合（不要使用会话）。

事实上，微软已经在 Microsoft.AspNet.Identity.IdentityExtensions 命名空间。 例如，GetUserId() 是一个返回用户 ID 的扩展方法。 还有 GetUserName() 和 FindFirstValue()，它们返回基于 IPrincipal 的声明。

因此，您只需包含命名空间，然后调用 User.Identity.GetUserName() 即可获取 ASP.NET Identity 配置的用户名。

我不确定这是否被缓存，因为旧的 ASP.NET Identity 不是开源的，而且我也懒得对其进行逆向工程。 但是，如果不是，那么您可以编写自己的扩展方法，该方法会将此结果缓存特定的时间。

Answer 8

我尝试了LukeP建议的解决方案，发现它不支持Authorize属性。 所以，我稍微修改了一下。

public class UserExBusinessInfo
{
    public int BusinessID { get; set; }
    public string Name { get; set; }
}

public class UserExInfo
{
    public IEnumerable<UserExBusinessInfo> BusinessInfo { get; set; }
    public int? CurrentBusinessID { get; set; }
}

public class PrincipalEx : ClaimsPrincipal
{
    private readonly UserExInfo userExInfo;
    public UserExInfo UserExInfo => userExInfo;

    public PrincipalEx(IPrincipal baseModel, UserExInfo userExInfo)
        : base(baseModel)
    {
        this.userExInfo = userExInfo;
    }
}

public class PrincipalExSerializeModel
{
    public UserExInfo UserExInfo { get; set; }
}

public static class IPrincipalHelpers
{
    public static UserExInfo ExInfo(this IPrincipal @this) => (@this as PrincipalEx)?.UserExInfo;
}


    [HttpPost]
    [AllowAnonymous]
    [ValidateAntiForgeryToken]
    public async Task<ActionResult> Login(LoginModel details, string returnUrl)
    {
        if (ModelState.IsValid)
        {
            AppUser user = await UserManager.FindAsync(details.Name, details.Password);

            if (user == null)
            {
                ModelState.AddModelError("", "Invalid name or password.");
            }
            else
            {
                ClaimsIdentity ident = await UserManager.CreateIdentityAsync(user, DefaultAuthenticationTypes.ApplicationCookie);
                AuthManager.SignOut();
                AuthManager.SignIn(new AuthenticationProperties { IsPersistent = false }, ident);

                user.LastLoginDate = DateTime.UtcNow;
                await UserManager.UpdateAsync(user);

                PrincipalExSerializeModel serializeModel = new PrincipalExSerializeModel();
                serializeModel.UserExInfo = new UserExInfo()
                {
                    BusinessInfo = await
                        db.Businesses
                        .Where(b => user.Id.Equals(b.AspNetUserID))
                        .Select(b => new UserExBusinessInfo { BusinessID = b.BusinessID, Name = b.Name })
                        .ToListAsync()
                };

                JavaScriptSerializer serializer = new JavaScriptSerializer();

                string userData = serializer.Serialize(serializeModel);

                FormsAuthenticationTicket authTicket = new FormsAuthenticationTicket(
                         1,
                         details.Name,
                         DateTime.Now,
                         DateTime.Now.AddMinutes(15),
                         false,
                         userData);

                string encTicket = FormsAuthentication.Encrypt(authTicket);
                HttpCookie faCookie = new HttpCookie(FormsAuthentication.FormsCookieName, encTicket);
                Response.Cookies.Add(faCookie);

                return RedirectToLocal(returnUrl);
            }
        }
        return View(details);
    }

最后在 Global.asax.cs

    protected void Application_PostAuthenticateRequest(Object sender, EventArgs e)
    {
        HttpCookie authCookie = Request.Cookies[FormsAuthentication.FormsCookieName];

        if (authCookie != null)
        {
            FormsAuthenticationTicket authTicket = FormsAuthentication.Decrypt(authCookie.Value);
            JavaScriptSerializer serializer = new JavaScriptSerializer();
            PrincipalExSerializeModel serializeModel = serializer.Deserialize<PrincipalExSerializeModel>(authTicket.UserData);
            PrincipalEx newUser = new PrincipalEx(HttpContext.Current.User, serializeModel.UserExInfo);
            HttpContext.Current.User = newUser;
        }
    }

现在我可以通过调用来访问视图和控制器中的数据要注销

User.ExInfo()

我只需调用

AuthManager.SignOut();

AuthManager 所在的位置

HttpContext.GetOwinContext().Authentication

Answer 9

我是这样做的。

我决定使用 IPrincipal 而不是 IIdentity，因为这意味着我不必同时实现 IIdentity 和 IPrincipal。

1. 创建界面

   接口 ICustomPrincipal : IPrincipal 
     { 
         int Id { 得到;   放;   } 
         字符串名字{获取;   放;   } 
         字符串姓氏{获取;   放;   } 
     } 
     

2. CustomPrincipal

   公共类 CustomPrincipal : ICustomPrincipal 
     { 
         公共IIdentity身份{获取;   私人套装；   } 
         公共 bool IsInRole(字符串角色) { return false;   } 
   
         公共 CustomPrincipal（字符串电子邮件） 
         { 
             this.Identity = new GenericIdentity(电子邮件); 
         } 
   
         公共 int Id { 得到;   放;   } 
         公共字符串名字{获取;   放;   } 
         公共字符串姓氏{获取;   放;   } 
     } 
     

3. CustomPrincipalSerializeModel - 用于将自定义信息序列化到 FormsAuthenticationTicket 对象中的 userdata 字段中。

   公共类 CustomPrincipalSerializeModel 
     { 
         公共 int Id { 得到;   放;   } 
         公共字符串名字{获取;   放;   } 
         公共字符串姓氏{获取;   放;   } 
     } 
     

4. 登录方法 - 使用自定义信息设置 cookie

   if (Membership.ValidateUser(viewModel.Email, viewModel.Password)) 
     { 
         var user = userRepository.Users.Where(u => u.Email == viewModel.Email).First(); 
   
         CustomPrincipalSerializeModel serializeModel = new CustomPrincipalSerializeModel(); 
         SerializeModel.Id = 用户.Id; 
         SerializeModel.FirstName = user.FirstName; 
         SerializeModel.LastName = user.LastName; 
   
         JavaScriptSerializer 序列化器 = new JavaScriptSerializer(); 
   
         字符串 userData = serializer.Serialize(serializeModel); 
   
         FormsAuthenticationTicket authTicket = 新 FormsAuthenticationTicket( 
                  1、 
                  viewModel.电子邮件， 
                  日期时间.现在, 
                  日期时间.Now.AddMinutes(15), 
                  错误的， 
                  用户数据）; 
   
         字符串 encTicket = FormsAuthentication.Encrypt(authTicket); 
         HttpCookie faCookie = new HttpCookie(FormsAuthentication.FormsCookieName, encTicket); 
         Response.Cookies.Add(faCookie); 
   
         返回 RedirectToAction("索引", "主页"); 
     } 
     

5. Global.asax.cs - 读取 cookie 并替换 HttpContext.User 对象，这是通过重写 PostAuthenticateRequest 来完成的

   protected void Application_PostAuthenticateRequest(对象发送者, EventArgs e) 
     { 
         HttpCookie authCookie = Request.Cookies[FormsAuthentication.FormsCookieName]; 
   
         if (authCookie != null) 
         { 
             FormsAuthenticationTicket authTicket = FormsAuthentication.Decrypt(authCookie.Value); 
   
             JavaScriptSerializer 序列化器 = new JavaScriptSerializer(); 
   
             CustomPrincipalSerializeModel serializeModel = serializer.Deserialize(authTicket.UserData); 
   
             CustomPrincipal newUser = new CustomPrincipal(authTicket.Name); 
             newUser.Id = serializeModel.Id; 
             newUser.FirstName = serializeModel.FirstName; 
             newUser.LastName = serializeModel.LastName; 
   
             HttpContext.Current.User = newUser; 
         } 
     } 
     

6. 在 Razor 视图中访问

   来 完成的

   @((用户作为 CustomPrincipal).Id) 
     @((用户作为 CustomPrincipal).FirstName) 
     @((用户作为 CustomPrincipal).LastName) 
     

和代码中访问：

    (User as CustomPrincipal).Id
    (User as CustomPrincipal).FirstName
    (User as CustomPrincipal).LastName

我认为代码是不言自明的。 如果不是，请告诉我。

此外，为了使访问更加容易，您可以创建一个基本控制器并覆盖返回的 User 对象（HttpContext.User）：

public class BaseController : Controller
{
    protected virtual new CustomPrincipal User
    {
        get { return HttpContext.User as CustomPrincipal; }
    }
}

然后，对于每个控制器：

public class AccountController : BaseController
{
    // ...
}

这将允许您访问代码中的自定义字段，如下所示：

User.Id
User.FirstName
User.LastName

但这不起作用内部视图。 为此，您需要创建一个自定义 WebViewPage 实现：

public abstract class BaseViewPage : WebViewPage
{
    public virtual new CustomPrincipal User
    {
        get { return base.User as CustomPrincipal; }
    }
}

public abstract class BaseViewPage<TModel> : WebViewPage<TModel>
{
    public virtual new CustomPrincipal User
    {
        get { return base.User as CustomPrincipal; }
    }
}

使其成为 Views/web.config 中的默认页面类型：

<pages pageBaseType="Your.Namespace.BaseViewPage">
  <namespaces>
    <add namespace="System.Web.Mvc" />
    <add namespace="System.Web.Mvc.Ajax" />
    <add namespace="System.Web.Mvc.Html" />
    <add namespace="System.Web.Routing" />
  </namespaces>
</pages>

并且在视图中，您可以像这样访问它：

@User.FirstName
@User.LastName