.Net6使用JWT认证和授权

2024-03-07 20:20
文章标签 使用 认证 授权 jwt net6

本文主要是介绍.Net6使用JWT认证和授权,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

文章目录

  • 目的
  • 实现案例
    • 一.项目所需包:
    • 二.配置项目 appsettings.json 文件:
    • 三.创建Model文件夹,添加AppConfig类和UserRole类
      • 1.AppConfig类获取appsettings.json文件中的值
      • 2.UserRole类用于区分用户信息和权限
    • 四.主体代码案例:
      • 1.LoginController 控制器,实现用户登录,JWT授权
      • 2.HomeController 控制器,无需登录,游客模式也能访问
      • 3.UserRoleController 控制器,用户登录之后可以访问
      • 4.AdminController 控制器,管理员权限登录之后可以访问
      • 5.在Program中注册JWT,swagge添加Jwt入口
    • 五.项目运行
      • 1.游客模式:
      • 2.普通用户模式:
      • 3.接着使用管理员账户登录,访问admin/hello
  • 结果


目的

.Net6使用JWT实现登录认证和授权
接口分三种类型:
1.游客模式:没有登录也可以访问的接口
2.用户模式:普通用户登录,可以访问的接口(登录即可访问)
3.管理模式:鉴定Token权限,拥有管理员资格的用户,才能访问

https://gitee.com/hgcjd/JWTDemoTest.git


实现案例

一.项目所需包:

在这里插入图片描述


二.配置项目 appsettings.json 文件:

配置jwt所需信息
在这里插入图片描述

{"Logging": {"LogLevel": {"Default": "Information","Microsoft.AspNetCore": "Warning"}},"AllowedHosts": "*","JwtTokenOptions": {"Issuer": "http://xxxx.com","Audience": "http://xxxx.com","SecurityKey": "qwertyuiopasdfghjklzxcvbnm1234567890"}
}

三.创建Model文件夹,添加AppConfig类和UserRole类

1.AppConfig类获取appsettings.json文件中的值

/// <summary>
/// 获取.NetCore配置文件信息
/// </summary>
public class AppConfig
{public static string GetConfigInfo(string Key){var builder = new ConfigurationBuilder().SetBasePath(Directory.GetCurrentDirectory()).AddJsonFile("appsettings.json");IConfigurationRoot configuration = builder.Build();string configStr = configuration.GetSection($"{Key}").Value;if (!string.IsNullOrWhiteSpace(configStr)){return configStr;}return null;}}

2.UserRole类用于区分用户信息和权限

/// <summary>
/// 用户,权限
/// </summary>
public class UserRole
{//权限public int Role { get; set; }/// <summary>/// 用户名/// </summary>public string UserId { get; set; }/// <summary>/// 密码/// </summary>public string Password { get; set; }
}

四.主体代码案例:

1.LoginController 控制器,实现用户登录,JWT授权

[Route("login")]
[ApiController]
public class LoginController : ControllerBase
{/// <summary>/// 用户列表/// </summary>private readonly static List<UserRole> _Users = new List<UserRole>(){new UserRole{ Role = 1,UserId = "administrator",Password = "123456" },   //管理员new UserRole{ Role = 0,UserId = "user",Password = "1"}   //普通用户};/// <summary>/// 管理权限配置/// </summary>private readonly static List<Claim> _administrator = new List<Claim>() {new Claim(ClaimTypes.Name,"administrator"),new Claim(ClaimTypes.Role,"administrator"),new Claim(ClaimTypes.Role,"user"),};/// <summary>/// 普通用户权限配置/// </summary>private readonly static List<Claim> _user = new List<Claim>() {new Claim(ClaimTypes.Name,"user"),new Claim(ClaimTypes.Role,"user"),};/// <summary>/// 用户登录接口/// </summary>/// <param name="userid"></param>/// <param name="password"></param>/// <returns></returns>[Route("login")][HttpPost]public string Login(string userid,string password){if (!string.IsNullOrWhiteSpace(userid) && !string.IsNullOrWhiteSpace(password)){var list = _Users.Where(e => e.UserId.ToString() == userid && e.Password == password).ToList();if (list != null && list.Count > 0){var userInfo = list[0];var claims = new List<Claim>();if (userInfo.Role == 1)claims = _administrator;//管理权限elseclaims = _user;//普通用户JwtSecurityToken token = new JwtSecurityToken(issuer:AppConfig.GetConfigInfo("JwtTokenOptions:Issuer"),audience: AppConfig.GetConfigInfo("JwtTokenOptions:Audience"),claims: claims,expires: DateTime.Now.AddMinutes(5),signingCredentials: new SigningCredentials(new SymmetricSecurityKey(Encoding.UTF8.GetBytes(AppConfig.GetConfigInfo("JwtTokenOptions:SecurityKey"))), SecurityAlgorithms.HmacSha256)); string tokenStr = new JwtSecurityTokenHandler().WriteToken(token);return tokenStr;}}return null;}
}

2.HomeController 控制器,无需登录,游客模式也能访问

/// <summary>
/// 公共接口,游客也可以访问
/// </summary>
[Route("Home")]
[ApiController]
public class HomeController : ControllerBase
{[Route("Hello")][HttpGet]public async Task<string> HelloAction(){return "Hello People~";}
}

3.UserRoleController 控制器,用户登录之后可以访问

通过 [Authorize]属性实现,该属性也可以放在单个接口上,使单个接口需要权限认证

/// <summary>
/// 登录后,用户权限是User的才能访问
/// </summary>
[Route("UserRole")]
[ApiController]
//[Authorize(Roles ="user")]
[Authorize]
public class UserRoleController : ControllerBase
{[Route("Hello")][HttpGet]public async Task<string> HelloUser(){return "Hello User~";}
}

4.AdminController 控制器,管理员权限登录之后可以访问

通过 [Authorize(Roles = “administrator”)]实现,Roles 标注需要的权限类型,该属性也可以放在接口上

/// <summary>
/// 管理员登录,才能访问
/// </summary>
[Route("AdminRole")]
[ApiController]
[Authorize(Roles = "administrator")]
public class AdminController : ControllerBase
{[Route("Hello")][HttpGet]public async Task<string> HelloAdmin(){return "Hello Administrator~";}
}

5.在Program中注册JWT,swagge添加Jwt入口

using JwtDemoTest.Model;
using Microsoft.AspNetCore.Authentication.JwtBearer;
using Microsoft.IdentityModel.Tokens;
using Microsoft.OpenApi.Models;
using System.Text;var builder = WebApplication.CreateBuilder(args);// Add services to the container.builder.Services.AddControllers();
// Learn more about configuring Swagger/OpenAPI at https://aka.ms/aspnetcore/swashbuckle
builder.Services.AddEndpointsApiExplorer();
builder.Services.AddSwaggerGen();#region 注册Jwt认证
builder.Services.AddAuthentication(JwtBearerDefaults.AuthenticationScheme).AddJwtBearer("Bearer", o =>
{o.TokenValidationParameters = new TokenValidationParameters{ValidateIssuerSigningKey = true,//是否验证签名,不验证的画可以篡改数据,不安全IssuerSigningKey = new SymmetricSecurityKey(Encoding.ASCII.GetBytes(AppConfig.GetConfigInfo("JwtTokenOptions:SecurityKey"))),//解密的密钥ValidateIssuer = true,//是否验证发行人,就是验证载荷中的Iss是否对应ValidIssuer参数ValidIssuer = AppConfig.GetConfigInfo("JwtTokenOptions:Issuer"),//发行人,ValidateAudience = true,//是否验证订阅人,就是验证载荷中的Aud是否对应ValidAudience参数ValidAudience = AppConfig.GetConfigInfo("JwtTokenOptions:Audience")//订阅人       };
});
builder.Services.AddAuthorization();
#endregion#region swagge添加Jwt认证
builder.Services.AddSwaggerGen(c =>
{c.SwaggerDoc("v1", new OpenApiInfo { Title = "My WebApi JwtDemoTest", Version = "v1" });// 定义安全定义c.AddSecurityDefinition("Bearer", new OpenApiSecurityScheme{Description = "JWT Authorization header using the Bearer scheme",Name = "Authorization",In = ParameterLocation.Header,Type = SecuritySchemeType.ApiKey,Scheme = "Bearer"});// 添加认证要求c.AddSecurityRequirement(new OpenApiSecurityRequirement{{new OpenApiSecurityScheme{Reference = new OpenApiReference{Type = ReferenceType.SecurityScheme,Id = "Bearer"}},Array.Empty<string>()}});
});
#endregionvar app = builder.Build();app.UseAuthentication();// Configure the HTTP request pipeline.
if (app.Environment.IsDevelopment())
{app.UseSwagger();app.UseSwaggerUI();
}app.UseAuthorization();app.MapControllers();app.Run();

五.项目运行

1.游客模式:

项目未登录,也可访问Home/Hello接口
在这里插入图片描述

2.普通用户模式:

普通用户登录获取Token,然后调用接口访问成功
首先调用login/login接口,获取普通用户权限token
在这里插入图片描述
接口携带token
在这里插入图片描述
携带普通用户登录后的token之后,访问 userrole/hello 接口成功
在这里插入图片描述

3.接着使用管理员账户登录,访问admin/hello

在这里插入图片描述

结果

.Net6 JWT搭建认证,授权,鉴权成功

这篇关于.Net6使用JWT认证和授权的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/784713

相关文章

Python使用FastAPI实现大文件分片上传与断点续传功能

《Python使用FastAPI实现大文件分片上传与断点续传功能》大文件直传常遇到超时、网络抖动失败、失败后只能重传的问题,分片上传+断点续传可以把大文件拆成若干小块逐个上传,并在中断后从已完成分片继... 目录一、接口设计二、服务端实现(FastAPI)2.1 运行环境2.2 目录结构建议2.3 serv

Spring Security简介、使用与最佳实践

《SpringSecurity简介、使用与最佳实践》SpringSecurity是一个能够为基于Spring的企业应用系统提供声明式的安全访问控制解决方案的安全框架,本文给大家介绍SpringSec... 目录一、如何理解 Spring Security?—— 核心思想二、如何在 Java 项目中使用?——

springboot中使用okhttp3的小结

《springboot中使用okhttp3的小结》OkHttp3是一个JavaHTTP客户端,可以处理各种请求类型,比如GET、POST、PUT等,并且支持高效的HTTP连接池、请求和响应缓存、以及异... 在 Spring Boot 项目中使用 OkHttp3 进行 HTTP 请求是一个高效且流行的方式。

Java使用Javassist动态生成HelloWorld类

《Java使用Javassist动态生成HelloWorld类》Javassist是一个非常强大的字节码操作和定义库,它允许开发者在运行时创建新的类或者修改现有的类,本文将简单介绍如何使用Javass... 目录1. Javassist简介2. 环境准备3. 动态生成HelloWorld类3.1 创建CtC

使用Python批量将.ncm格式的音频文件转换为.mp3格式的实战详解

《使用Python批量将.ncm格式的音频文件转换为.mp3格式的实战详解》本文详细介绍了如何使用Python通过ncmdump工具批量将.ncm音频转换为.mp3的步骤,包括安装、配置ffmpeg环... 目录1. 前言2. 安装 ncmdump3. 实现 .ncm 转 .mp34. 执行过程5. 执行结

Java使用jar命令配置服务器端口的完整指南

《Java使用jar命令配置服务器端口的完整指南》本文将详细介绍如何使用java-jar命令启动应用,并重点讲解如何配置服务器端口,同时提供一个实用的Web工具来简化这一过程,希望对大家有所帮助... 目录1. Java Jar文件简介1.1 什么是Jar文件1.2 创建可执行Jar文件2. 使用java

C#使用Spire.Doc for .NET实现HTML转Word的高效方案

《C#使用Spire.Docfor.NET实现HTML转Word的高效方案》在Web开发中,HTML内容的生成与处理是高频需求,然而,当用户需要将HTML页面或动态生成的HTML字符串转换为Wor... 目录引言一、html转Word的典型场景与挑战二、用 Spire.Doc 实现 HTML 转 Word1

Java中的抽象类与abstract 关键字使用详解

《Java中的抽象类与abstract关键字使用详解》:本文主要介绍Java中的抽象类与abstract关键字使用详解,本文通过实例代码给大家介绍的非常详细,感兴趣的朋友跟随小编一起看看吧... 目录一、抽象类的概念二、使用 abstract2.1 修饰类 => 抽象类2.2 修饰方法 => 抽象方法,没有

MyBatis ParameterHandler的具体使用

《MyBatisParameterHandler的具体使用》本文主要介绍了MyBatisParameterHandler的具体使用,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参... 目录一、概述二、源码1 关键属性2.setParameters3.TypeHandler1.TypeHa

Spring 中的切面与事务结合使用完整示例

《Spring中的切面与事务结合使用完整示例》本文给大家介绍Spring中的切面与事务结合使用完整示例,本文通过实例代码给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友参考... 目录 一、前置知识:Spring AOP 与 事务的关系 事务本质上就是一个“切面”二、核心组件三、完