热门标签 | HotTags
当前位置:  开发笔记 > 编程语言 > 正文

ASP.NETCORE中使用Cookie身份认证

原文:ASP.NETCORE中使用Cookie身份认证大家在使用ASP.NET的时候一定都用过FormsAuthentication做登录用户的身份认证,FormsAuthenti
原文:ASP.NET CORE中使用COOKIE身份认证

大家在使用ASP.NET的时候一定都用过FormsAuthentication做登录用户的身份认证,FormsAuthentication的核心就是COOKIE,ASP.NET会将用户名存储在COOKIE中。

现在到了ASP.NET CORE的时代,但是ASP.NET CORE中没有FormsAuthentication这个东西,那么怎么做身份认证呢?答案是ASP.NET CORE已经为我们内置了COOKIE身份认证的功能,而且使用起来非常方便,注意本文是基于ASP.NET CORE 2.0版本来阐述COOKIE认证方式的。

1.从ASP.NET CORE OWIN框架中启用COOKIE身份认证功能


要在ASP.NET CORE中使用COOKIE身份认证,第一步就是在项目中的OWIN框架文件Startup.cs中启用COOKIE身份认证中间件。

首先我们在Startup中的ConfigureServices方法中使用services.AddAuthentication注册COOKIE认证服务,如下代码所示:

public void ConfigureServices(IServiceCollection services)
{
    services.AddMvc();

    //注册COOKIE认证服务
    services.AddAuthentication(COOKIEAuthenticationDefaults.AuthenticationScheme).AddCOOKIE();
}

注意,我们还可以用AddCOOKIE的重载方法,来设置存储用户登录信息(用户Token信息)COOKIE的属性,详情可以查看COOKIEBuilder,如下代码所示:

public void ConfigureServices(IServiceCollection services)
{
    services.AddMvc();

    //注册COOKIE认证服务
    services
    .AddAuthentication(COOKIEAuthenticationDefaults.AuthenticationScheme)
    .AddCOOKIE(COOKIEAuthenticationDefaults.AuthenticationScheme, option =>
    {
        option.COOKIE.Name = "MyApplicationTokenCOOKIE";//设置存储用户登录信息(用户Token信息)的COOKIE名称
        option.COOKIE.HttpOnly= true;//设置存储用户登录信息(用户Token信息)的COOKIE,无法通过客户端浏览器脚本(如Javascript等)访问到
        option.COOKIE.SecurePolicy = Microsoft.AspNetCore.Http.COOKIESecurePolicy.Always;//设置存储用户登录信息(用户Token信息)的COOKIE,只会通过HTTPS协议传递,如果是HTTP协议,COOKIE不会被发送。注意,option.COOKIE.SecurePolicy属性的默认值是Microsoft.AspNetCore.Http.COOKIESecurePolicy.SameAsRequest
    });
}

注意,option.COOKIE.SecurePolicy属性的值是枚举类型Microsoft.AspNetCore.Http.COOKIESecurePolicy,其默认值是Microsoft.AspNetCore.Http.COOKIESecurePolicy.SameAsRequest。当我们使用上面的代码,来设置存储用户登录信息(用户Token信息)COOKIE的属性后,在用户成功登录我们的站点后,我们可以看到客户端浏览器在HTTP响应中,会收到如下COOKIE信息,和我们上面代码中设置的三个COOKIE属性是匹配的:

技术图片

然后在Startup中的Configure方法中使用app.UseAuthentication启用COOKIE认证中间件(注意其中app.UseAuthentication和app.UseMvc的调用顺序不能反),如下代码所示:

public void Configure(IApplicationBuilder app, IHostingEnvironment env)
{
    if (env.IsDevelopment())
    {
        app.UseDeveloperExceptionPage();
        app.UseBrowserLink();
    }
    else
    {
        app.UseExceptionHandler("/Home/Error");
    }

    app.UseStaticFiles();

    //注意app.UseAuthentication方法一定要放在下面的app.UseMvc方法前面,否者后面就算调用HttpContext.SignInAsync进行用户登录后,使用
    //HttpContext.User还是会显示用户没有登录,并且HttpContext.User.Claims读取不到登录用户的任何信息。
    //这说明Asp.Net OWIN框架中MiddleWare的调用顺序会对系统功能产生很大的影响,各个MiddleWare的调用顺序一定不能反
    app.UseAuthentication();

    app.UseMvc(routes =>
    {
        routes.MapRoute(
            name: "default",
            template: "{cOntroller=Home}/{action=Index}/{id?}");
    });

            
}

这里顺便说一下app.UseAuthentication是用来干什么的,app.UseAuthentication会启用Authentication中间件,该中间件会根据当前Http请求中的COOKIE信息来设置HttpContext.User属性(后面会用到),所以只有在app.UseAuthentication方法之后注册的中间件才能够从HttpContext.User中读取到值,这也是为什么上面强调app.UseAuthentication方法一定要放在下面的app.UseMvc方法前面,因为只有这样ASP.NET Core的MVC中间件中才能读取到HttpContext.User的值。

ASP.NET Core 3.0

由于在ASP.NET Core 3.0中,app.UseMvcapp.UseRoutingapp.UseEndpoints替代,所以app.UseAuthenticationapp.UseAuthorization,要放在app.UseRoutingapp.UseCors之后,并且在app.UseEndpoints之前,如下所示:

// This method gets called by the runtime. Use this method to configure the HTTP request pipeline.
public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
{
    if (env.IsDevelopment())
    {
        app.UseDeveloperExceptionPage();
    }
    else
    {
        app.UseExceptionHandler("/Home/Error");
    }

    app.UseStaticFiles();

    app.UseRouting();
    app.UseCors();

    app.UseAuthentication();
    app.UseAuthorization();

    app.UseEndpoints(endpoints =>
    {
        endpoints.MapControllerRoute(
            name: "default",
            pattern: "{cOntroller=Home}/{action=Index}/{id?}");
    });
}

详情可以查看:Migrate from ASP.NET Core 2.2 to 3.0

2.登录用户


在ASP.NET CORE中使用COOKIE认证登录用户的方法和传统的FormsAuthentication不太一样,大致步骤如下:

  • 创建Claim类型的数组,将登录用户的所有信息(比如用户名)存储在Claim类型的字符串键值对中
  • 将上面创建的Claim类型的数组传入ClaimsIdentity中,用来构造一个ClaimsIdentity对象
  • 将上面创建的ClaimsIdentity对象传入ClaimsPrincipal中,用来构造一个ClaimsPrincipal对象
  • 调用HttpContext.SignInAsync方法,传入上面创建的ClaimsPrincipal对象,完成用户登录

所以我们可以看到整个ASP.NET CORE的COOKIE认证登录流程比以前ASP.NET的FormsAuthentication还是要复杂许多,毕竟以前一个FormsAuthentication.SetAuthCOOKIE方法就搞定了。

在本文的例子中我们在项目中默认的HomeController中创建了一个Acion方法Login,来实现用户登录的代码。当然这里我们实现的是最简的COOKIE登录,下面代码中实际上还可以设置COOKIE是否持久化、COOKIE多久过期、存储登录用户信息的COOKIE的名字是什么等,我们就不做过多介绍了,大家可以阅读本文最后推荐的两份官方文档了解更多。

Login方法的代码如下:

/// 
/// 该Action登录用户Wangdacui到Asp.Net Core
/// 
public IActionResult Login()
{
    //下面的变量claims是Claim类型的数组,Claim是string类型的键值对,所以claims数组中可以存储任意个和用户有关的信息,
    //不过要注意这些信息都是加密后存储在客户端浏览器COOKIE中的,所以最好不要存储太多特别敏感的信息,这里我们只存储了用户名到claims数组,
    //表示当前登录的用户是谁
    var claims = new[] { new Claim("UserName", "Wangdacui") };

    var claimsIdentity = new ClaimsIdentity(
    claims,
    COOKIEAuthenticationDefaults.AuthenticationScheme);

    ClaimsPrincipal user = new ClaimsPrincipal(claimsIdentity);

    Task.Run(async () =>
    {
        //登录用户,相当于ASP.NET中的FormsAuthentication.SetAuthCOOKIE
        await HttpContext.SignInAsync(COOKIEAuthenticationDefaults.AuthenticationScheme, user);

        //可以使用HttpContext.SignInAsync方法的重载来定义持久化COOKIE存储用户认证信息,例如下面的代码就定义了用户登录后60分钟内COOKIE都会保留在客户端计算机硬盘上,
        //即便用户关闭了浏览器,60分钟内再次访问站点仍然是处于登录状态,除非调用Logout方法注销登录。
        //注意其中的AllowRefresh属性,如果AllowRefresh为true,表示如果用户登录后在超过50%的ExpiresUtc时间间隔内又访问了站点,就延长用户的登录时间(其实就是延长COOKIE在客户端计算机硬盘上的保留时间),
        //例如本例中我们下面设置了ExpiresUtc属性为60分钟后,那么当用户登录后在大于30分钟且小于60分钟内访问了站点,那么就将用户登录状态再延长到当前时间后的60分钟。但是用户在登录后的30分钟内访问站点是不会延长登录时间的,
        //因为ASP.NET Core有个硬性要求,是用户在超过50%的ExpiresUtc时间间隔内又访问了站点,才延长用户的登录时间。
        //如果AllowRefresh为false,表示用户登录后60分钟内不管有没有访问站点,只要60分钟到了,立马就处于非登录状态(不延长COOKIE在客户端计算机硬盘上的保留时间,60分钟到了客户端计算机就自动删除COOKIE)
        /*
        await HttpContext.SignInAsync(
        COOKIEAuthenticationDefaults.AuthenticationScheme,
        user, new AuthenticationProperties()
        {
            IsPersistent = true,
            ExpiresUtc = DateTimeOffset.UtcNow.AddMinutes(60),
            AllowRefresh = true
        });
        */

    }).Wait();

    return View();
}

如果当前Http请求本来登录了用户A,现在调用HttpContext.SignInAsync方法登录用户B,那么相当于注销用户A,登录用户B

3.读取登录用户信息


那么用户登录后怎么将登录用户的信息(比如用户名)读取出来呢?我们在HomeController的Index方法中演示了如何判断当前用户是否已经登录,并且读出登录用户的用户名,Index方法的代码如下所示:

/// 
/// 该Action判断用户是否已经登录,如果已经登录,那么读取登录用户的用户名
/// 
public IActionResult Index()
{
    //如果HttpContext.User.Identity.IsAuthenticated为true,
    //或者HttpContext.User.Claims.Count()大于0表示用户已经登录
    if (HttpContext.User.Identity.IsAuthenticated)
    {
        //这里通过 HttpContext.User.Claims 可以将我们在Login这个Action中存储到COOKIE中的所有
        //claims键值对都读出来,比如我们刚才定义的UserName的值Wangdacui就在这里读取出来了
        var userName = HttpContext.User.Claims.First().Value;
    }

    return View();
}

注意,最好还是用HttpContext.User.Identity.IsAuthenticated来判断用户是否已经登录

4.注销用户


那么登录用户后怎么注销登录呢?我们在HomeController的Logout方法中演示了如何注销登录的用户,代码如下所示:

/// 
/// 该Action从Asp.Net Core中注销登录的用户
/// 
public IActionResult Logout()
{
    Task.Run(async () =>
    {
        //注销登录的用户,相当于ASP.NET中的FormsAuthentication.SignOut  
        await HttpContext.SignOutAsync();
    }).Wait();

    return View();
}

如果当前Http请求本来就没有登录用户,那么调用HttpContext.SignOutAsync方法时也不会报错

5.负载均衡


警告:
ASP.NET Core使用 ASP.NET Core data protection stack 来实现COOKIE身份认证。如果在服务器集群中必须配置 ASP.NET Core Data Protection,有关详细信息,请参阅 Configuring data protection。如果你的ASP.NET Core站点使用了负载均衡部署了多个实例,就要做ASP.NET Core Data Protection的配置,否则ASP.NET CORE跨多个实例进行COOKIE身份认证会失败。

还可以参考:Host ASP.NET Core in a web farm 以及 Share authentication COOKIEs among ASP.NET apps

如何管理ASP.NET Core Data Protection的过期key,可以查看:Data Protection - how to manage expired key? 

前面说了实际上在ASP.NET CORE的COOKIE认证中还可以设置COOKIE的名字、是否持久化存储等,可以参考如下两篇官方文档了解:

Using COOKIE Authentication without ASP.NET Core Identity

Cutting Edge - COOKIEs, Claims and Authentication in ASP.NET Core

ASP.NET CORE中使用COOKIE身份认证


推荐阅读
  • 如果应用程序经常播放密集、急促而又短暂的音效(如游戏音效)那么使用MediaPlayer显得有些不太适合了。因为MediaPlayer存在如下缺点:1)延时时间较长,且资源占用率高 ... [详细]
  • 网络爬虫的规范与限制
    本文探讨了网络爬虫引发的问题及其解决方案,重点介绍了Robots协议的作用和使用方法,旨在为网络爬虫的合理使用提供指导。 ... [详细]
  • 微软推出Windows Terminal Preview v0.10
    微软近期发布了Windows Terminal Preview v0.10,用户可以在微软商店或GitHub上获取这一更新。该版本在2月份发布的v0.9基础上,新增了鼠标输入和复制Pane等功能。 ... [详细]
  • 解决Parallels Desktop错误15265的方法
    本文详细介绍了在使用Parallels Desktop时遇到错误15265的多种解决方案,包括检查网络连接、关闭代理服务器和修改主机文件等步骤。 ... [详细]
  • 解决 Windows Server 2016 网络连接问题
    本文详细介绍了如何解决 Windows Server 2016 在使用无线网络 (WLAN) 和有线网络 (以太网) 时遇到的连接问题。包括添加必要的功能和安装正确的驱动程序。 ... [详细]
  • 在使用Eclipse进行调试时,如果遇到未解析的断点(unresolved breakpoint)并显示“未加载符号表,请使用‘file’命令加载目标文件以进行调试”的错误提示,这通常是因为调试器未能正确加载符号表。解决此问题的方法是通过GDB的`file`命令手动加载目标文件,以便调试器能够识别和解析断点。具体操作为在GDB命令行中输入 `(gdb) file `。这一步骤确保了调试环境能够正确访问和解析程序中的符号信息,从而实现有效的调试。 ... [详细]
  • 系统数据实体验证异常:多个实体验证失败的错误处理与分析
    在使用MVC和EF框架进行数据保存时,遇到了 `System.Data.Entity.Validation.DbEntityValidationException` 错误,表明存在一个或多个实体验证失败的情况。本文详细分析了该错误的成因,并提出了有效的处理方法,包括检查实体属性的约束条件、调试日志的使用以及优化数据验证逻辑,以确保数据的一致性和完整性。 ... [详细]
  • LDAP服务器配置与管理
    本文介绍如何通过安装和配置SSSD服务来统一管理用户账户信息,并实现其他系统的登录调用。通过图形化交互界面配置LDAP服务器,确保用户账户信息的集中管理和安全访问。 ... [详细]
  • 本文详细介绍了Java代码分层的基本概念和常见分层模式,特别是MVC模式。同时探讨了不同项目需求下的分层策略,帮助读者更好地理解和应用Java分层思想。 ... [详细]
  • 本文详细介绍了如何解决DNS服务器配置转发无法解析的问题,包括编辑主配置文件和重启域名服务的具体步骤。 ... [详细]
  • Ext JS MVC系列一:环境搭建与框架概览
    本文主要介绍了如何在项目中使用Ext JS 4作为前端框架,并详细讲解了Ext JS 4的MVC开发模式。文章将从项目目录结构、相关CSS和JS文件的引用以及MVC框架的整体认识三个方面进行总结。 ... [详细]
  • Framework7:构建跨平台移动应用的高效框架
    Framework7 是一个开源免费的框架,适用于开发混合移动应用(原生与HTML混合)或iOS&Android风格的Web应用。此外,它还可以作为原型开发工具,帮助开发者快速创建应用原型。 ... [详细]
  • 本文介绍了如何使用 CMD 批处理脚本进行文件操作,包括将指定目录下的 PHP 文件重命名为 HTML 文件,并将这些文件复制到另一个目录。 ... [详细]
  • 解决Bootstrap DataTable Ajax请求重复问题
    在最近的一个项目中,我们使用了JQuery DataTable进行数据展示,虽然使用起来非常方便,但在测试过程中发现了一个问题:当查询条件改变时,有时查询结果的数据不正确。通过FireBug调试发现,点击搜索按钮时,会发送两次Ajax请求,一次是原条件的请求,一次是新条件的请求。 ... [详细]
  • 第二十五天接口、多态
    1.java是面向对象的语言。设计模式:接口接口类是从java里衍生出来的,不是python原生支持的主要用于继承里多继承抽象类是python原生支持的主要用于继承里的单继承但是接 ... [详细]
author-avatar
倾城修罗__598
这个家伙很懒,什么也没留下!
PHP1.CN | 中国最专业的PHP中文社区 | DevBox开发工具箱 | json解析格式化 |PHP资讯 | PHP教程 | 数据库技术 | 服务器技术 | 前端开发技术 | PHP框架 | 开发工具 | 在线工具
Copyright © 1998 - 2020 PHP1.CN. All Rights Reserved | 京公网安备 11010802041100号 | 京ICP备19059560号-4 | PHP1.CN 第一PHP社区 版权所有