目录
本文演示如何在ASP.NET CORE中使用JWT(JSON Web令牌)实现令牌身份验证和授权。本文中使用的方法不使用任何客户端cookie进行身份验证和授权。这意味着,令牌没有存储在客户端浏览器中,它是完全从服务器端处理的。由于本文主要侧重于实现ASP.NET CORE身份验证和授权,因此我们不会深入研究令牌配置和令牌创建。从实现的角度来看,仅简要介绍了令牌配置和创建。有很多文章详细解释了它。本文包含完整的代码和LoginDemo.sln项目。
在进入本主题之前,让我们简要介绍一下身份验证和授权。
身份验证:授予用户访问/许可以进入应用程序的权限。就像给人访问/许可进入建筑物的权限。
授权:这是在身份验证之后进行的。仅向用户授予应用程序某些页面的权限。这就像谁有权访问/许可进入10层楼的人,只能去2 或4 楼。
就像说的那样,JWToken是JSON格式的字符串值。为每个有效用户发出JWToken(身份验证)。在用户登录期间,令牌仅创建一次。用户将在随后的所有HTTP授权请求中使用该令牌,直到该用户从应用程序注销为止。
我们不会涉及JWToken配置的每个细节。有很多文章对此进行了解释。使用 Microsoft.AspNetCore.Authentication.JwtBearer和Microsoft.IdentityModel.Tokens配置JWT。这是在Startup.cs中的 ConfigurationServices()方法中完成的。
您可以在下面的代码中看到,有两个部分令牌配置,services.AddAuthentication()和AddJwtBearer()。
services.AddAuthentication():此部分用于配置我们将要使用的身份验证方案或机制。在这里,我们告诉ASP.NET Core使用JWT承载令牌身份验证。这非常重要,因为这将在Configure()以后的方法中使用。
AddJwtBearer():在本部分中,我们使用密钥,到期日期,使用者等配置Token。密钥用于加密和解密令牌。创建令牌时应使用相同的密钥,我们将在“创建令牌”主题中看到。
- public void ConfigureServices(IServiceCollection services)
- {
- services.AddSession(options => {
- options.IdleTimeout = TimeSpan.FromMinutes(60);
- });
- services.AddMvc().SetCompatibilityVersion(CompatibilityVersion.Version_2_1);
-
- //Provide a secret key to Encrypt and Decrypt the Token
- var SecretKey = Encoding.ASCII.GetBytes
- ("YourKey-2374-OFFKDI940NG7:56753253-tyuw-5769-0921-kfirox29zoxv");
- //Configure JWT Token Authentication
- services.AddAuthentication(auth =>
- {
- auth.DefaultAuthenticateScheme = JwtBearerDefaults.AuthenticationScheme;
- auth.DefaultChallengeScheme = JwtBearerDefaults.AuthenticationScheme;
- })
- .AddJwtBearer(token =>
- {
- token.RequireHttpsMetadata = false;
- token.SaveToken = true;
- token.TokenValidationParameters = new TokenValidationParameters
- {
- ValidateIssuerSigningKey = true,
- //Same Secret key will be used while creating the token
- IssuerSigningKey = new SymmetricSecurityKey(SecretKey),
- ValidateIssuer = true,
- //Usually, this is your application base URL
- ValidIssuer = "http://localhost:45092/",
- ValidateAudience = true,
- //Here, we are creating and using JWT within the same application.
- //In this case, base URL is fine.
- //If the JWT is created using a web service, then this would be the consumer URL.
- ValidAudience = "http://localhost:45092/",
- RequireExpirationTime = true,
- ValidateLifetime = true,
- ClockSkew = TimeSpan.Zero
- };
- });
- }
我们需要一个模型类供用户登录。使用用户ID,密码和其他凭据为User创建一个模型类。在“Models”文件夹下创建一个类User.cs。
- public class User
- {
- public string USERID { get; set; }
- public string PASSWORD { get; set; }
- public string FIRST_NAME { get; set; }
- public string LAST_NAME { get; set; }
- public string EMAILID { get; set; }
- public string PHONE { get; set; }
- public string ACCESS_LEVEL { get; set; }
- public string READ_ONLY { get; set; }
- }
让我们创建一个TokenProvider.cs类,它将为用户创建/生成令牌。令牌仅创建一次,并在所有后续请求中使用,直到用户注销。在解决方案的根文件夹下,创建一个TokenProvider.cs类。
在创建Token之前,我们需要从登录页面获取UserID,并检查用户是否存在于我们的数据库中。出于演示目的,用户列表是存储在列表中的硬编码值。在现实世界中,这可能来自数据库或某些数据源。让我们向TokenProvider.cs类添加一个属性(UserList)。此属性是我们的用户数据存储区,几乎没有硬编码值。
- //Using hard coded collection list as Data Store for demo purposes
- //In reality, User data comes from Database or other Data Source.
- private List UserList = new List
- {
- new User { USERID = "jsmith@email.com", PASSWORD = "test",
- EMAILID = "jsmith@email.com", FIRST_NAME = "John",
- LAST_NAME = "Smith", PHONE = "356-735-2748",
- ACCESS_LEVEL = "Director", READ_ONLY = "true" },
- new User { USERID = "srob@email.com", PASSWORD = "test",
- FIRST_NAME = "Steve", LAST_NAME = "Rob",
- EMAILID = "srob@email.com", PHONE = "567-479-8537",
- ACCESS_LEVEL = "Supervisor", READ_ONLY = "false" },
- new User { USERID = "dwill@email.com", PASSWORD = "test",
- FIRST_NAME = "DJ", LAST_NAME = "Will",
- EMAILID = "dwill@email.com", PHONE = "599-306-6010",
- ACCESS_LEVEL = "Analyst", READ_ONLY = "false" },
- new User { USERID = "JBlack@email.com", PASSWORD = "test",
- FIRST_NAME = "Joe", LAST_NAME = "Black",
- EMAILID = "JBlack@email.com", PHONE = "764-460-8610",
- ACCESS_LEVEL = "Analyst", READ_ONLY = "true" }
- };
第3步
我们需要在令牌中为应用程序设置用户权限(授权)。在令牌中,我们需要说明用户可以具有的权限级别。用户权限创建为Claims。创建令牌时,我们将在Claims对象集合中设置用户权限,并将其分配给Token。这些Claims值将用于在控制器中授予权限/授权用户。在MVC控制器的操作方法中,我们将使用“ACCESS_LEVEL”和“READ_ONLY”声明来设置用户权限。出于演示目的,对用户声明进行了硬编码。在这里,您可以连接到数据库并获得用户许可。
让我们添加一个方法(GetUserClaims())以获取用户权限级别并在TokenProvider.cs类中构建声明对象集合。
- //Using hard coded values in claims collection list as Data Store for demo.
- //In reality, User data comes from Database or other Data Source.
- private IEnumerable GetUserClaims(User user)
- {
- IEnumerable claims = new Claim[]
- {
- new Claim(ClaimTypes.Name, user.FIRST_NAME + " " + user.LAST_NAME),
- new Claim("USERID", user.USERID),
- new Claim("EMAILID", user.EMAILID),
- new Claim("PHONE", user.PHONE),
- new Claim("ACCESS_LEVEL", user.ACCESS_LEVEL.ToUpper()),
- new Claim("READ_ONLY", user.READ_ONLY.ToUpper())
- };
- return claims;
- }
现在是时候为用户创建令牌了。首先,从登录页面获取用户ID,并检查用户是否在上面声明的UserList集合属性中。如果用户ID在列表中,则我们有一个注册用户。如果不是,则认证失败。不要发行令牌。
其次,从登录页面获取密码,然后检查密码是否与UserList中的密码匹配。如果是,则为用户创建一个令牌。如果不是,则认证失败,并且不创建/发行令牌。
要创建JWToken,我们将使用两个名称空间System.IdentityModel.Tokens.Jwt和Microsoft.IdentityModel.Tokens。让我们使用JwtSecurityToken()类创建令牌(此处,我不介绍令牌创建的详细信息。有很多文章介绍了JWT令牌创建)。在创建令牌时,用户声明值将加载到令牌“claims”属性中。我们正在调用上面的函数GetUserClaims(),该函数为用户加载声明。Token在采用UserID和Password作为输入的LoginUser()方法中创建。
让我们创建一个函数LoginUser(),其将TokenProvider.cs中的UserID和Password作为输入参数。
- public string LoginUser(string UserID, string Password)
- {
- //Get user details for the user who is trying to login
- var user = UserList.SingleOrDefault(x => x.USERID == UserID);
-
- //Authenticate User, Check if it’s a registered user in Database
- if (user == null)
- return null;
-
- //If it‘s registered user, check user password stored in Database
- //For demo, password is not hashed. Simple string comparison
- //In real, password would be hashed and stored in DB. Before comparing, hash the password
- if (Password == user.PASSWORD)
- {
- //Authentication successful, Issue Token with user credentials
- //Provide the security key which was given in the JWToken configuration in Startup.cs
- var key = Encoding.ASCII.GetBytes
- ("YourKey-2374-OFFKDI940NG7:56753253-tyuw-5769-0921-kfirox29zoxv");
- //Generate Token for user
- var JWToken = new JwtSecurityToken(
- issuer: "http://localhost:45092/",
- audience: "http://localhost:45092/",
- claims: GetUserClaims(user),
- notBefore: new DateTimeOffset(DateTime.Now).DateTime,
- expires: new DateTimeOffset(DateTime.Now.AddDays(1)).DateTime,
- //Using HS256 Algorithm to encrypt Token
- signingCredentials: new SigningCredentials(new SymmetricSecurityKey(key),
- SecurityAlgorithms.HmacSha256Signature)
- );
- var token = new JwtSecurityTokenHandler().WriteToken(JWToken);
- return token;
- }
- else
- {
- return null;
- }
- }
几点要考虑...
创建令牌时,我们需要提供与Startup.cs中JWToken配置的安全密钥相同的安全密钥。
- var key = Encoding.ASCII.GetBytes
- ("YourKey-2374-OFFKDI940NG7:56753253-tyuw-5769-0921-kfirox29zoxv");
“issuer”和“audience”应与在ConfigureServices()方法的Startup.cs中配置的值相同。
最后,TokenProvider.cs类如下所示:
- using LoginDemo.Models;
- using Microsoft.IdentityModel.Tokens;
- using System;
- using System.Collections.Generic;
- using System.IdentityModel.Tokens.Jwt;
- using System.Linq;
- using System.Security.Claims;
- using System.Text;
- using System.Threading.Tasks;
-
- namespace LoginDemo
- {
- public class TokenProvider
- {
- public string LoginUser(string UserID, string Password)
- {
- //Get user details for the user who is trying to login
- var user = UserList.SingleOrDefault(x => x.USERID == UserID);
-
- //Authenticate User, Check if it’s a registered user in Database
- if (user == null)
- return null;
-
- //If it is registered user, check user password stored in Database
- //For demo, password is not hashed. It is just a string comparision
- //In reality, password would be hashed and stored in Database.
- //Before comparing, hash the password again.
- if (Password == user.PASSWORD)
- {
- //Authentication successful, Issue Token with user credentials
- //Provide the security key which is given in
- //Startup.cs ConfigureServices() method
- var key = Encoding.ASCII.GetBytes
- ("YourKey-2374-OFFKDI940NG7:56753253-tyuw-5769-0921-kfirox29zoxv");
- //Generate Token for user
- var JWToken = new JwtSecurityToken(
- issuer: "http://localhost:45092/",
- audience: "http://localhost:45092/",
- claims: GetUserClaims(user),
- notBefore: new DateTimeOffset(DateTime.Now).DateTime,
- expires: new DateTimeOffset(DateTime.Now.AddDays(1)).DateTime,
- //Using HS256 Algorithm to encrypt Token
- signingCredentials: new SigningCredentials
- (new SymmetricSecurityKey(key), SecurityAlgorithms.HmacSha256Signature)
- );
- var token = new JwtSecurityTokenHandler().WriteToken(JWToken);
- return token;
- }
- else
- {
- return null;
- }
- }
-
- //Using hard coded collection list as Data Store for demo.
- //In reality, User details would come from Database.
- private List UserList = new List
- {
- new User { USERID = "jsmith@email.com",
- PASSWORD = "test", EMAILID = "jsmith@email.com",
- FIRST_NAME = "John", LAST_NAME = "Smith",
- PHONE = "356-735-2748", ACCESS_LEVEL = "Director",
- READ_ONLY = "true" },
- new User { USERID = "srob@email.com", PASSWORD = "test",
- FIRST_NAME = "Steve", LAST_NAME = "Rob",
- EMAILID = "srob@email.com", PHONE = "567-479-8537",
- ACCESS_LEVEL = "Supervisor", READ_ONLY = "false" },
- new User { USERID = "dwill@email.com", PASSWORD = "test",
- FIRST_NAME = "DJ", LAST_NAME = "Will",
- EMAILID = "dwill@email.com", PHONE = "599-306-6010",
- ACCESS_LEVEL = "Analyst", READ_ONLY = "false" },
- new User { USERID = "JBlack@email.com", PASSWORD = "test",
- FIRST_NAME = "Joe", LAST_NAME = "Black",
- EMAILID = "JBlack@email.com", PHONE = "764-460-8610",
- ACCESS_LEVEL = "Analyst", READ_ONLY = "true" }
- };
-
- //Using hard coded collection list as Data Store for demo.
- //In reality, User data comes from Database or other Data Source
- private IEnumerable GetUserClaims(User user)
- {
- IEnumerable claims = new Claim[]
- {
- new Claim(ClaimTypes.Name, user.FIRST_NAME + " " + user.LAST_NAME),
- new Claim("USERID", user.USERID),
- new Claim("EMAILID", user.EMAILID),
- new Claim("PHONE", user.PHONE),
- new Claim("ACCESS_LEVEL", user.ACCESS_LEVEL.ToUpper()),
- new Claim("READ_ONLY", user.READ_ONLY.ToUpper())
- };
- return claims;
- }
- }
- }
现在,我们已经验证了用户身份并为该用户颁发了令牌,我们需要将该令牌存储在某个位置,直到用户从应用程序注销为止。这是必需的,因为在成功登录后,令牌需要在每个后续的HTTP请求中传递。如上所述,我们将不使用任何客户端(浏览器)cookie来存储令牌。
相反,我们将在用户SESSION的服务器端存储令牌。创建一个SESSION变量并将令牌存储在其中。成功登录后,对于每个后续请求,我们将从session变量获取令牌并将其插入到传入的HTTP请求中。
我们将在HomeController下面的操作方法中执行此操作,从TokenProvider.cs中获取令牌,创建Session对象“JWToken”并存储令牌。
在HomeController.cs中,有一个“LoginUser”操作方法。用户可以从Index.cshtml输入用户ID和密码,并将页面提交到HomeController.cs中的“LoginUser”操作方法。在“LoginUser”控制器操作方法中,我们将令牌添加到会话对象名称“JWToken”。
这是整个实现过程的关键部分。这部分更多是一个概念,几行代码。我们将在这里做两件事:
首先让我们了解一下这个概念。为了保持简单,请忍受。
身份验证和授权通过HTTP请求进行处理,以实现以下目的:
要达到上述目的:
下图给出了有关如何将Token插入HTTP标头并在HTTP上下文中设置Claims Principle的想法。
使用此自定义中间件将令牌插入传入HTTP请求的主要思想。现在,我们已经记录了存储在Session变量“JWToken” 中的用户令牌,我们需要将该令牌插入所有后续传入的HTTP请求中。为此,我们将向ASP.NET Core中间件编写几行代码。这不过是HTTP管道。自定义中间件已添加到Startup.cs Configure()方法中。
PS:Token在用户登录期间仅创建一次。
现在,我们需要验证令牌并将声明加载到HTTP Request上下文。UseAuthentication()为我们做这项工作。在HTTP请求命中MVC控制器之前,UseAuthentication()执行以下操作:
在Startup.cs中,将以下代码添加到Configure()方法中。在之后添加以下代码app.UseCookiePolicy()。在这里,代码执行顺序很重要。
- app.UseSession();
- //Add JWToken to all incoming HTTP Request Header
- app.Use(async (context, next) =>
- {
- var JWToken = context.Session.GetString("JWToken");
- if (!string.IsNullOrEmpty(JWToken))
- {
- context.Request.Headers.Add("Authorization", "Bearer " + JWToken);
- }
- await next();
- });
- //Add JWToken Authentication service
- app.UseAuthentication();
让我们看一下代码:
var JWToken = context.Session.GetString("JWToken");
context.Request.Headers.Add("Authorization", "Bearer " + JWToken);
最后,Startup.cs Configure()方法如下所示:
- // This method gets called by the runtime.
- // Use this method to configure the HTTP request pipeline.
- public void Configure(IApplicationBuilder app, IHostingEnvironment env)
- {
- if (env.IsDevelopment())
- {
- app.UseDeveloperExceptionPage();
- }
- else
- {
- app.UseExceptionHandler("/Home/Error");
- }
- app.UseStaticFiles();
- app.UseCookiePolicy();
-
- //Add User session
- app.UseSession();
-
- //Add JWToken to all incoming HTTP Request Header
- app.Use(async (context, next) =>
- {
- var JWToken = context.Session.GetString("JWToken");
- if (!string.IsNullOrEmpty(JWToken))
- {
- context.Request.Headers.Add("Authorization", "Bearer " + JWToken);
- }
- await next();
- });
- //Add JWToken Authentication service
- app.UseAuthentication();
-
- app.UseMvc(routes =>
- {
- routes.MapRoute(
- name: "default",
- template: "{controller=Home}/{action=Index}/{id?}");
- });
- }
现在,我们创建一个带有用户ID和密码文本框的简单登录页面(Index.cshtml)。添加User.cs模型以查看页面。在这里,您可以看到检查用户是否已通过身份验证的IF条件User.Identity.IsAuthenticated。“User”对象是System.Security.Claims的一部分,由中间件在HTTP上下文中设置。如果用户已通过身份验证,我们将通过claims标识名称属性显示用户名。如果不是,那么我们要求用户登录。
- @model LoginDemo.Models.User
- @{
- ViewData["Title"] = "Home Page";
- }
- <div style="padding-top:50px;"></div>
- <div style="padding-top:50px;">
- @if (User.Identity.IsAuthenticated)
- {
- <div class="row">
- You are Logged in as
- <span style="font-size:large;color:forestgreen;">
- @User.Identity.Name</span>
- </div>
- <div class="row" style="padding-top:50px;">
- @Html.ActionLink("Log Off", "Logoff",
- "Home", null, new { @class = "btn btn-primary btn-lg rph-login-button" })
- </div>
- }
- else
- {
- <div class="row">
- <div class="col-lg-4 col-md-4 col-sm-4">
- <div>
- @using (Html.BeginForm("LoginUser", "Home",
- FormMethod.Post, new { role = "form" }))
- {
- <div>
- @Html.AntiForgeryToken()
- <div>
- <label>User ID</label><br />
- </div>
- <div>
- @Html.TextBoxFor(m => m.USERID,
- new {@class = "form-control txtbox"})
- </div>
- <div style="padding-top:20px;"></div>
- <div>
- <label>Password</label><br />
- </div>
- <div>
- @Html.PasswordFor(m => m.USERID,
- new {@class = "form-control txtbox"})
- </div>
- </div>
- <div class="padding-left:35%;width:40%;">
- <div class="padding-top:20px;">
- <input class="btn btn-primary
- btn-lg rph-login-button"
- type="submit" value="Login"/>
- </div>
- </div>
- }
- </div>
- </div>
- <div class="col-lg-8 col-md-8 col-sm-8">
- <div style="padding-top:50px;">
- <div><b>Please login with any of the below User ID,
- Password is span style="font-size:large;color:forestgreen;"
- >test</span> for all Users</b></div>
- <div style="padding-top:10px;">
- <ui style="list-style: none;">
- <li>jsmith@email.com - Director, Read Only - true</li>
- <li>srob@email.com - Supervisor, Read Only - false</li>
- <li>dwill@email.com - Analyst, Read Only - false</li>
- <li>JBlack@email.com - Analyst, Read Only - true</li>
- </ui>
- </div>
- </div>
- </div>
- </div>
- }
- </div>
让我们在HomeController.cs中添加两个Action方法。一个用于Index(登录)页面,另一个用于提交登录页面。
- public IActionResult Index()
- {
- return View();
- }
-
- public IActionResult LoginUser(User user)
- {
- TokenProvider _tokenProvider = new TokenProvider();
- //Authenticate user
- var userToken = _tokenProvider.LoginUser(user.USERID.Trim(), user.PASSWORD.Trim());
- if (userToken != null)
- {
- //Save token in session object
- HttpContext.Session.SetString("JWToken", userToken);
- }
- return Redirect("~/Home/Index");
- }
Action方法LoginUser(User user)从登录页面获取用户ID和密码值。下一行通过检查数据存储中的用户ID和密码来进行身份验证。
var userToken = _tokenProvider.LoginUser(user.USERID.Trim(), user.PASSWORD.Trim());
接下来的几行通过TokenProvider()检查是否存在发行的令牌。如果是,则将令牌保存在用户Session变量“JWToken”中。
- if (userToken != null)
- {
- //Save token in session object
- HttpContext.Session.SetString("JWToken", userToken);
- }
然后,将页面重定向到Index.cshtml:
return Redirect("~/Home/Index");
在页面重定向期间,我们已经将令牌存储在session对象中。现在,页面重定向通过Startup.cs中的HTTP管道进行。现在,自定义中间件将停止HTTP Request,并将令牌插入HTTP Request标头“Authorization”。请参阅“中间件”以获取更多详细信息(上面章节)。
如果token在session变量“JWToken” 中不可用,则HTTP Request标头“Authorization”将为空。在这种情况下,Context将不会为该用户设置HTTP 。重定向将要求用户登录。
让我们注销用户。如果没有令牌,则无法为用户设置HTTP上下文。因此,token从session对象中删除。要从session中除去token,请清除该用户的session并重定向到另一个控制器动作。
添加一个控制器动作方法Logoff()。为用户清除session并重定向到Index操作方法中。重定向到另一个控制器操作方法很重要。让我们看看为什么?假设在Logoff()操作方法中,我们返回View()而不是Redirect()。在这种情况下,视图页面将呈现给浏览器,并且仍然用户可以访问该页面,User.Identity.IsAuthenticated仍然是true。当ASP.NET执行控制器操作方法时,它正在HTTP RESPONSE的过程中。这意味着它已经通过HTTP REQUEST传递了。用户 Claims Principle在HTTP Request中设置。通过注销用户,我们还需要清除该用户的Claims Principle。仅清除会话是不够的。因此,我们需要再次通过HTTP管道。重定向到另一个控制器通过HTTP管道,它将查找在session变量“JWToken”中的Token。但是,我们已经清除了session,token将不会在session中了。没有令牌,就不能在HTTP上下文中设置Claims Principle。这将完全注销用户。
- public IActionResult Logoff()
- {
- HttpContext.Session.Clear();
- return Redirect("~/Home/Index");
- }
控制器代码
- using System;
- using System.Collections.Generic;
- using System.Diagnostics;
- using System.Linq;
- using System.Threading.Tasks;
- using Microsoft.AspNetCore.Mvc;
- using LoginDemo.Models;
- using System.Security.Claims;
- using Microsoft.AspNetCore.Http;
-
- namespace LoginDemo.Controllers
- {
- public class HomeController : Controller
- {
- public IActionResult Index()
- {
- return View();
- }
-
- public IActionResult LoginUser(User user)
- {
- TokenProvider _tokenProvider = new TokenProvider();
- var userToken = _tokenProvider.LoginUser(user.USERID.Trim(),
- user.PASSWORD.Trim());
- if (userToken != null)
- {
- //Save token in session object
- HttpContext.Session.SetString("JWToken", userToken);
- }
- return Redirect("~/Home/Index");
- }
-
- public IActionResult Logoff()
- {
- HttpContext.Session.Clear();
- return Redirect("~/Home/Index");
- }
- }
- }
在第2部分中,我们将介绍对用户的授权。我们将看到:
使用JWT的ASP.NET CORE令牌身份验证和授权(无Cookie)——第1部分
原文:https://www.cnblogs.com/lonelyxmas/p/11913807.html