在ASP.NET Core中轻松使用JwtBeare进行身份验证

  • 在ASP.NET Core中轻松使用JwtBeare进行身份验证已关闭评论
  • 101 次浏览
  • A+
所属分类:.NET技术
摘要

JwtBearer简介首先要搞清楚什么是JwtBearer,JwtBearer是ASP.NET Core的OAuth 2.0 JWT Bearer身份验证提供程序。它提供了对JWT令牌进行验证的功能,然后允许将令牌中包含的声明(claims)用于用户身份验证和授权控制。

JwtBearer简介

首先要搞清楚什么是JwtBearer,JwtBearer是ASP.NET Core的OAuth 2.0 JWT Bearer身份验证提供程序。它提供了对JWT令牌进行验证的功能,然后允许将令牌中包含的声明(claims)用于用户身份验证和授权控制。

Json Web Token (JWT)是一种Web标准,用于在不同系统间传输数据。JWT是一种可验证的和安全的方式,用于在各种应用程序之间传递信息。JWT具有一定的安全性,因为它是通过密钥对JWT进行签名的,以确保意味着不能进行篡改或伪造。

JWT由三个部分组成,分别为:“Header”、“Payload”和“Signature” 。其中,“header”表示JWT的元数据(元信息),用于描述加密信息和算法;“payload”表示JWT的指令部分,用于承载用户状态或授权相关的信息;“signature”表示JWT的签名信息,用于验证JWT的有效性。

JwtBearer首先使用“header”中声明的算法对JWT进行身份验证,以确保其未被篡改。然后,它将使用密钥根据“payload”中的信息生成令牌,以在用户请求中将其传递。

JwtBearer提供了配置选项,以允许您使用自定义的密钥和算法生成和验证JWT令牌。它还允许您配置应用程序特定的声明,以在用户的身份验证和授权管理中使用。

在.NET Core中使用

1)、首先新建一个APS.NET Core项目,然后在项目中添加JwtBearer包,可以用nuget包管理器添加,也可以使用nuget命令添加,命令如下:

dotnet add package  Microsoft.AspNetCore.Authentication.JwtBearer 

2)新建一个JwtConfig类,用了存储token相关数据。

public class JwtConfig     {         public string Key { get; set; } //key         public int Expres { get; set; } //过期时间(单位秒)         public string Issuer { get; set; }         public string Audience { get; set; }     } 

3)、在appsettings.json中配置jwt密钥

//配置文件appsettings.json {   "Logging": {     "LogLevel": {       "Default": "Information",       "Microsoft.AspNetCore": "Warning"     }   },   "AllowedHosts": "*",   //JWT的配置内容   "JWT": {//key必须有足够的长度       "Key": "asfasfdflj134aanjkdsjiio1232sdasdfdfkandsf12",     "expres": "3",      "Issuer": "https://localhost:7201",     "Audience": "https://localhost:7201",   } } 

4)在program.cs文件注入JwtBearer

//注入配置类 builder.Services.Configure<JwtConfig>(builder.Configuration.GetSection("JWT")); 

5)新建一个类,专门创建token

//依赖注入   private readonly IOptionsSnapshot<JwtConfig> jwtconfig;   public Demo3Controller(IOptionsSnapshot<JwtConfig> jwtconfig)   {      this.jwtconfig = jwtconfig;   } public string CreateToken() {     // 创建声明列表,即 Token 中携带的信息     List<Claim> claims = new List<Claim>();     claims.Add(new Claim(ClaimTypes.Name, "admin")); // 添加用户名     claims.Add(new Claim(ClaimTypes.NameIdentifier, "1080")); // 添加用户 ID      // 设置 Token 的过期时间     DateTime expres = DateTime.Now.AddSeconds(jwtconfig.Value.Expres);     Console.WriteLine($"过期时间{expres}");      // 从配置文件中获取 JWT 密钥并转换为字节数组     byte[] secbyse = Encoding.UTF8.GetBytes(jwtconfig.Value.Key);      // 创建 SymmetricSecurityKey 对象并使用 HmacSha256 算法对密钥进行签名     var secKey = new SymmetricSecurityKey(secbyse);     var credetials = new SigningCredentials(secKey, SecurityAlgorithms.HmacSha256);      // 创建 JwtSecurityToken 对象并设置声明、过期时间和签名信息     var tokenDescriptor = new JwtSecurityToken(claims: claims, expires: expres, signingCredentials: credetials);      // 生成 JWT Token 字符串并返回     string jwt = new JwtSecurityTokenHandler().WriteToken(tokenDescriptor);     return jwt; } 

6)再在program.cs文件中验证传入的token,代码如下:

builder.Services.AddAuthentication(JwtBearerDefaults.AuthenticationScheme).AddJwtBearer(opt => {     var JwtOtp = builder.Configuration.GetSection("JWT").Get<JwtConfig>();     byte[] keybase = Encoding.UTF8.GetBytes(JwtOtp.Key);     var seckey = new SymmetricSecurityKey(keybase);     opt.TokenValidationParameters = new()     {         ValidateIssuer = false,         ValidateAudience = false,         ValidateLifetime = true,         ValidateIssuerSigningKey = true,         IssuerSigningKey = seckey,      };     opt.Events = new JwtBearerEvents     {         //权限验证失败后执行         OnChallenge = context =>         {             //终止默认的返回结果             context.HandleResponse();             string token = context.Request.Headers["Authorization"];             var result = JsonConvert.SerializeObject(new { code = 401, message = "登录过期" });             if (string.IsNullOrEmpty(token))             {                 result = JsonConvert.SerializeObject(new { code = 401, message = "token不能为空" });                 context.Response.ContentType = "application/json";                 //验证失败返回401                 context.Response.StatusCode = StatusCodes.Status200OK;                 context.Response.WriteAsync(result);                 return Task.FromResult(result);             }             try             {                 JwtSecurityTokenHandler tokenheader = new();                 ClaimsPrincipal claimsPrincipal = tokenheader.ValidateToken(token, opt.TokenValidationParameters, out SecurityToken securityToken);             }             catch (SecurityTokenExpiredException)             {                 result = JsonConvert.SerializeObject(new { code = 401, message = "登录已过期" });                 context.Response.ContentType = "application/json";                 //验证失败返回401                 context.Response.StatusCode = StatusCodes.Status200OK;                 context.Response.WriteAsync(result);                 return Task.FromResult(result);             }             catch (Exception ex)             {                 Console.WriteLine(ex);                 result = JsonConvert.SerializeObject(new { code = 402, message = "token令牌无效" });                 context.Response.ContentType = "application/json";                 //验证失败返回401                 context.Response.StatusCode = StatusCodes.Status200OK;                 context.Response.WriteAsync(result);                 return Task.FromResult(result);             }             context.Response.ContentType = "application/json";             //验证失败返回401             context.Response.StatusCode = StatusCodes.Status200OK;             context.Response.WriteAsync(result);             return Task.FromResult(result);         }     }; }); app.UseAuthentication();//.NETCore验证中间件,必须有。并且在   app.UseAuthorization();之前 

7)、在需要权限的方法或控制器上加上特性[Authorize]

[HttpGet(Name = "GetAuthorize")]  [Authorize] public IEnumerable<WeatherForecast> Get() {     //doing } 

这样就完成了JwtBearer验证的代码,具体调用见下文。

调用流程如下:

1)、首先获得Token

可以通过登录验证后生成。如果是接口程序通过接口获得。

效果如下:

在ASP.NET Core中轻松使用JwtBeare进行身份验证

2)、获取Token后在请求头添加Authorization验证,并输入获得的Token,需要注意的是Token前面需要加Bearer并添加一个空格。

效果如下:

在ASP.NET Core中轻松使用JwtBeare进行身份验证

如果Token为空的效果:

在ASP.NET Core中轻松使用JwtBeare进行身份验证

注:在swagger加token需要另外在program.cs配置,代码如下:

builder.Services.AddSwaggerGen(s => {     //添加安全定义     s.AddSecurityDefinition("Bearer", new OpenApiSecurityScheme     {         Description = "请输入token,格式为 Bearer xxxxxxxx(注意中间必须有空格)",         Name = "Authorization",         In = ParameterLocation.Header,         Type = SecuritySchemeType.ApiKey,         BearerFormat = "JWT",         Scheme = "Bearer"     });     //添加安全要求     s.AddSecurityRequirement(new OpenApiSecurityRequirement {     {         new OpenApiSecurityScheme{             Reference =new OpenApiReference{                 Type = ReferenceType.SecurityScheme,                 Id ="Bearer"             }         },new string[]{ }     } }); }); 

添加好重启程序后会在swagger的右上方增加如下按钮,打开按钮根据提示即可完成添加。

在ASP.NET Core中轻松使用JwtBeare进行身份验证

结语

本文介绍了ASP.NET Core如使用JwtBearer,以及JwtBearer生成token验证的验证过程。希望对你有所收获,欢迎留言或吐槽。

来源公众号:DotNet开发跳槽