C#实现JWT无状态验证的实战应用解析_c# jwt解析-程序员宅基地

技术标签: c#教程  C#教程  

前言
本文主要介绍JWT的实战运用。

准备工作
首先我们创建一个Asp.Net的,包含MVC和WebApi的Web项目。

然后使用Nuget搜索JWT,安装JWT类库,如下图。

在这里插入图片描述

设计思路
这里我们简单的做了一个token验证的设计,设计思路如下图所示:

在这里插入图片描述

代码实现
缓存

首先,我们先开发工具类,根据设计思路图可得知,我们需要一个缓存类,用于在服务器端存储token。

编写缓存相关类代码如下:

public class CacheHelper
 {
    
 public static object GetCache(string key)
 {
    
  return HttpRuntime.Cache[key];
 }public static T GetCache<T>(string key) where T : class
 {
    
  return (T)HttpRuntime.Cache[key];
 }public static bool ContainsKey(string key)
 {
    
  return GetCache(key) != null;
 }public static void RemoveCache(string key)
 {
    
  HttpRuntime.Cache.Remove(key);
 }public static void SetKeyExpire(string key, TimeSpan expire)
 {
    
  object value = GetCache(key);
  SetCache(key, value, expire);
 }public static void SetCache(string key, object value)
 {
    
  _SetCache(key, value, null, null);
 }public static void SetCache(string key, object value, TimeSpan timeout)
 {
    
  _SetCache(key, value, timeout, ExpireType.Absolute);
 }public static void SetCache(string key, object value, TimeSpan timeout, ExpireType expireType)
 {
    
  _SetCache(key, value, timeout, expireType);
 }private static void _SetCache(string key, object value, TimeSpan? timeout, ExpireType? expireType)
 {
    
  if (timeout == null)
  HttpRuntime.Cache[key] = value;
  else
  {
    
  if (expireType == ExpireType.Absolute)
  {
    
   DateTime endTime = DateTime.Now.AddTicks(timeout.Value.Ticks);
   HttpRuntime.Cache.Insert(key, value, null, endTime, Cache.NoSlidingExpiration);
  }
  else
  {
    
   HttpRuntime.Cache.Insert(key, value, null, Cache.NoAbsoluteExpiration, timeout.Value);
  }
  }
 }
 }
 /// <summary>
 /// 过期类型
 /// </summary>
 public enum ExpireType
 {
    
 /// <summary>
 /// 绝对过期
 /// 注:即自创建一段时间后就过期
 /// </summary>
 Absolute,/// <summary>
 /// 相对过期
 /// 注:即该键未被访问后一段时间后过期,若此键一直被访问则过期时间自动延长
 /// </summary>
 Relative,
 }

如上述代码所示,我们编写了缓存帮助类—CacheHelper类。

CacheHelper类:使用HttpRuntime的缓存,类里实现缓存的增删改,因为使用的是HttpRuntime,所以,如果没有设置缓存的超时时间,则缓存的超时时间等于HttpRuntime.Cache配置的默认超时时间。

如果网站挂载在IIS里,那么,HttpRuntime.Cache配置超时时间的地方在该网站的应用程序池中,如下图:

在这里插入图片描述

Jwt的帮助类
现在我们编写Jwt的帮助类,代码如下:

public class JwtHelper
{
    
 //私钥 
 public const string secret = "MIGfMA0GCSqGSIb3DQEBAQUAA4GNAmD7RTE2drj6hf3oZjJpMPZUQ1Qjb5H3K3PNwIDAQAB";
  
 /// <summary>
 /// <summary>
 /// 生成JwtToken
 /// </summary>
 /// <param name="payload">不敏感的用户数据</param>
 /// <returns></returns>
 public static string SetJwtEncode(string username,int expiresMinutes)
 {
    
 //格式如下
 var payload = new Dictionary<string, object>
 {
    
  {
     "username",username },
  {
     "exp ", expiresMinutes },
  {
     "domain", "" }
 };IJwtAlgorithm algorithm = new HMACSHA256Algorithm();
 IJsonSerializer serializer = new JsonNetSerializer();
 IBase64UrlEncoder urlEncoder = new JwtBase64UrlEncoder();
 IJwtEncoder encoder = new JwtEncoder(algorithm, serializer, urlEncoder);var token = encoder.Encode(payload, secret);
 return token;
 }
  
 /// <summary>
 /// 根据jwtToken 获取实体
 /// </summary>
 /// <param name="token">jwtToken</param>
 /// <returns></returns>
 public static IDictionary<string,object> GetJwtDecode(string token)
 {
    
 IJsonSerializer serializer = new JsonNetSerializer();
 IDateTimeProvider provider = new UtcDateTimeProvider();
 IJwtValidator validator = new JwtValidator(serializer, provider);
 IBase64UrlEncoder urlEncoder = new JwtBase64UrlEncoder();
 IJwtAlgorithm algorithm = new HMACSHA256Algorithm();
 IJwtDecoder decoder = new JwtDecoder(serializer, validator, urlEncoder, algorithm);
 var dicInfo = decoder.DecodeToObject(token, secret, verify: true);//token为之前生成的字符串
 return dicInfo;
 }
}

代码很简单,实现了JWT的Code的创建和解析。

注:JWT的Code虽然是密文,但它是可以被解析的,所以我们不要在Code里存储重要信息,比如密码。

JWT的Code与解析后的内容如下图所示,左边未Code,右边未解析的内容。

在这里插入图片描述

AuthenticationHelper验证帮助类
现在,我们已经可以编写验证类了,利用刚刚已创建的缓存帮助类和JWT帮助类。

AuthenticationHelper验证帮助类代码如下:

public class AuthenticationHelper
 {
    
 /// <summary>
 /// 默认30分钟
 /// </summary>
 /// <param name="username"></param>
 public static void AddUserAuth(string username)
 {
    
  var token = JwtHelper.SetJwtEncode(username, 30);
  CacheHelper.SetCache(username, token, new TimeSpan(TimeSpan.TicksPerHour / 2));
 }
 public static void AddUserAuth(string username, TimeSpan ts)
 {
    
  var token = JwtHelper.SetJwtEncode(username, ts.Minutes);
  CacheHelper.SetCache(username, token, ts);}
 public static string GetToken(string username)
 {
    
  var cachetoken = CacheHelper.GetCache(username);
  return cachetoken.ParseToString(); 
 }
 public static bool CheckAuth(string token)
 {
    
  var dicInfo = JwtHelper.GetJwtDecode(token);
  var username = dicInfo["username"];var cachetoken = CacheHelper.GetCache(username.ToString());
  if (!cachetoken.IsNullOrEmpty() && cachetoken.ToString() == token)
  {
    
  return true;
  }
  else
  {
    
  return false;
  }
 }
 }

如代码所示,我们实现了验证token创建、验证token获取、验证Token校验三个方法。

到此,我们的基础代码已经编写完了,下面进入验证的应用。

Fliter

首先,在Global.asax文件中,为我们WebApi添加一个过滤器,代码如下:

public class WebApiApplication : System.Web.HttpApplication
{
    
 protected void Application_Start()
 {
    
 AreaRegistration.RegisterAllAreas();
 GlobalConfiguration.Configure(WebApiConfig.Register);
 //webapiFilter
 System.Web.Http.GlobalConfiguration.Configuration.Filters.Add(new HttpPermissionFilter());
 System.Web.Http.GlobalConfiguration.Configuration.Filters.Add(new HttpExceptionFilter());
 //mvcFliter
 System.Web.Mvc.GlobalFilters.Filters.Add(new MvcExceptionFilter());
 System.Web.Mvc.GlobalFilters.Filters.Add(new MvcPermissionFilter());
 RouteConfig.RegisterRoutes(RouteTable.Routes);
 BundleConfig.RegisterBundles(BundleTable.Bundles);
 }
}

代码中创建了四个过滤器,分别是MVC的请求和异常过滤器和WebApi的请求和异常过滤器。

这里我们主要看WebApi的请求过滤器——HttpPermissionFilter。代码如下:

public class HttpPermissionFilter : System.Web.Http.Filters.ActionFilterAttribute
{
    
 public override void OnActionExecuting(HttpActionContext actionContext)
 {
    
 string url ="请求Url" + actionContext.Request.RequestUri.ToString();
 var action = actionContext.ActionDescriptor.ActionName.ToLower();
 var controller = actionContext.ControllerContext.ControllerDescriptor.ControllerName.ToLower();
 if (controller != "login" && controller != "loginout")
 {
    
  //客户端段token获取
  var token = actionContext.Request.Headers.Authorization != null ? actionContext.Request.Headers.Authorization.ToString() : "";
  //服务端获取token 与客户端token进行比较
  if (!token.IsNullOrEmpty() && AuthenticationHelper.CheckAuth(token))
  {
    
  //认证通过,可进行日志等处理
  }
  else
  {
    
  throw new Exception("Token无效");
  }
 }
 }
}

我们的HttpPermissionFilter类继承了System.Web.Http.Filters.ActionFilterAttribute,这样他就可以截获所有的WebApi请求了。然后我c#教程们重写了他的OnActionExecuting方法,在方法里,我们查询到当前请求的Controller的名称,然后对其进行了一个简单的判断,如果是login(登录)或loginout(登出),那我们就不对他的token进行验证。如果是其他请求,则会从请求的Headers的Authorization属性里读取token,并使用AuthenticationHelper类对这个token进行正确性的验证。

WebApi接口
现在我们编写WebApi接口,编写一个登录接口和一个普通请求接口。

登录接口:这里我们使用AuthenticationHelper类创建一个token,并把他存储到缓存中。

然后再把token返回给调用者。

普通接口:这里我们不做任何操作,就是简单的返回成功,因为是否可以访问这个接口,已经又Filter控制了。

代码如下:

public class LoginController : ApiController
{
     
 public string Get(string username,string pwd)
 {
    
 AuthenticationHelper.AddUserAuth(username, new TimeSpan(TimeSpan.TicksPerMinute * 5));//5分钟
 string token = AuthenticationHelper.GetToken(username);
 return token;
 } 
}
public class RequestController : ApiController
{
    
 public string Get()
 {
    
 return "请求成功";
 } 
}

测试页面

现在我们编写测试页面,这里我们实现三个按钮,登录、带token访问Api、无token访问Api。

代码如下:

<div>
 <script>
 $(document).ready(function () {
    
  $("#request").click(function () {
    
  var token = window.localStorage.getItem('token');
  if (token) {
    
​
   $.ajax({
    
   type: "GET",
   url: "http://localhost:50525/api/Request",
   success: function (data) {
    
    $('#con').append('<div> success:' + data + '</div>');
    console.log(data);
   },
   beforeSend: function (xhr) {
    
    //向Header头中添加Authirization
    xhr.setRequestHeader("Authorization", token);
   },
   error: function (XMLHttpRequest, textStatus, errorThrown) {
    
    $('#con').append('<div> error:' + errorThrown + '</div>');
   }
   });
  }
  else {
    
   alert("token不存在");
  }
  });
  $("#requestNotoken").click(function () {
    
  var token = window.localStorage.getItem('token');
  if (token) {
    
​
   $.ajax({
    
   type: "GET",
   url: "http://localhost:50525/api/Request",
   success: function (data) {
    
    $('#con').append('<div> success:' + data + '</div>');
    console.log(data);
   },
   error: function (XMLHttpRequest, textStatus, errorThrown) {
    
    $('#con').append('<div> error:' + errorThrown + '</div>');
   }
   });
  }
  else {
    
   alert("token不存在");
  }
  });
  $("#login").click(function () {
    
  $.ajax({
    
   type: "GET",
   url: "http://localhost:50525/api/Login/?username=kiba&pwd=518",
   success: function (data) {
    
    
   $('#con').append('<div> token:' + data + '</div>');
   console.log(data);
   window.localStorage.setItem('token', data) 
   }
  });
  });
 });
 </script>
 <h1>测试JWT</h1>
 <button id="login">登录</button>
 <button id="request">带token访问Api</button>
 <button id="requestNotoken">无token访问Api</button>
 <div id="con"></div>
</div>
<div>
 <script>
 $(document).ready(function () {
    
  $("#request").click(function () {
    
  var token = window.localStorage.getItem('token');
  if (token) {
    
​
   $.ajax({
    
   type: "GET",
   url: "http://localhost:50525/api/Request",
   success: function (data) {
    
    $('#con').append('<div> success:' + data + '</div>');
    console.log(data);
   },
   beforeSend: function (xhr) {
    
    //向Header头中添加Authirization
    xhr.setRequestHeader("Authorization", token);
   },
   error: function (XMLHttpRequest, textStatus, errorThrown) {
    
    $('#con').append('<div> error:' + errorThrown + '</div>');
   }
   });
  }
  else {
    
   alert("token不存在");
  }
  });
  $("#requestNotoken").click(function () {
    
  var token = window.localStorage.getItem('token');
  if (token) {
    
​
   $.ajax({
    
   type: "GET",
   url: "http://localhost:50525/api/Request",
   success: function (data) {
    
    $('#con').append('<div> success:' + data + '</div>');
    console.log(data);
   },
   error: function (XMLHttpRequest, textStatus, errorThrown) {
    
    $('#con').append('<div> error:' + errorThrown + '</div>');
   }
   });
  }
  else {
    
   alert("token不存在");
  }
  });
  $("#login").click(function () {
    
  $.ajax({
    
   type: "GET",
   url: "http://localhost:50525/api/Login/?username=kiba&pwd=518",
   success: function (data) {
    
   
   $('#con').append('<div> token:' + data + '</div>');
   console.log(data);
   window.localStorage.setItem('token', data) 
   }
  });
  });
 });
 </script>
 <h1>测试JWT</h1>
 <button id="login">登录</button>
 <button id="request">带token访问Api</button>
 <button id="requestNotoken">无token访问Api</button>
 <div id="con"></div>
</div>

测试结果如下:

在这里插入图片描述

如上图所示,我们已经成功实现简单的token验证。

到此JWT的实战应用就已经介绍完了。

代码已经传到Github上了,欢迎大家下载。

Github地址: https://github.com/kiba518/JwtNet

到此这篇关于C#实现JWT无状态验证的实战应用的文章就介绍到这了

版权声明:本文为博主原创文章,遵循 CC 4.0 BY-SA 版权协议,转载请附上原文出处链接和本声明。
本文链接:https://blog.csdn.net/chinaherolts2008/article/details/115056725

智能推荐

Selenium 根据元素文本内容定位_selenium java根据文字定位-程序员宅基地

文章浏览阅读1.8k次。使用xpath定位元素时,有时候担心元素位置会变,可以考虑使用文本内容来定位的方式。例如图中的【评价】按钮,只有按钮文本没变,就可以定位到该元素。_selenium java根据文字定位

Linux中设置固定ip的方法_linux设置固定ip-程序员宅基地

这篇文章介绍了在Linux中设置固定IP的方法,包括使用ifconfig命令查看网络状态、使用ping命令检查网络连接、修改网络配置文件和管理防火墙。

在readthedocs上部署mkdocs文本报错AttributeError:module ‘jinja2‘ has no attribute ‘contextfilter‘解决_attributeerror: module 'jinja2' has no attribute '-程序员宅基地

文章浏览阅读700次。关于在readthedocs上部署mkdocs时遇到的问题_attributeerror: module 'jinja2' has no attribute 'contextfunction

tensorflow版本与cuda cuDNN版本对应使用_tensorflow2对应的cuda-程序员宅基地

文章浏览阅读4.3w次,点赞8次,收藏57次。tensorflow-gpu v1.9.0 |cuda9.0 | cuDNN7.1.4可行 | 备注:7.0.4/ 7.0.5/ 7.1.2不明确tensorflow-gpu v1.8.0 | cuda9.0 | cuDNN 不明确 | 备注:7.0.4/ 7.0.5/ 7.1.2/ 7.1.4tensorflow-gpu v1.7.0 | cuda9.0 | cuDNN 不..._tensorflow2对应的cuda

UVA 147 Dollars 完全背包-程序员宅基地

文章浏览阅读332次。题目不难,一个完全背包而已。只是需要注意,我用double直接读入莫名WA,看了别人的题解才发现要+上一个0.005,可是我依然无法理解为什么是这样。#include#include#includeusing namespace std;;const int maxm=30000;long long arr[maxm+10]{1},value[11]={5,10,20,50,100_uva 147

SSM框架学习笔记之SpringMVC异常处理机制_ssm框架抛出异常-程序员宅基地

文章浏览阅读135次。SpringMVC的异常处理机制1.异常处理的思路  系统中异常包括两类:预期异常和运行时异常RuntimeException,前者通过捕获异常而获取异常信息,后者主要通过规范代码开发、测试等手段减少运行时异常的发生。  系统的Dao、Service、Controller出现都通过throws Exception向上抛出,最后由SpringMVC前端控制器交由异常处理机制进行异常处理,如下图:2.异常处理两种方式(1)使用SpringMVC提供的简单异常处理器SimpleMappingExcep_ssm框架抛出异常

随便推点

Flutter网络请求_flutter provider 网络请求-程序员宅基地

文章浏览阅读2k次。这里主要分享我对于Flutter网络请求方面的内容目的目的很简单,需要完成项目中常规的Http的GET和POST请求服务端接口数据以完成页面部分展示逻辑方案主要实现方案有三种,一种是基于原生的HttpClient来实现,另外两种是基于第三方package来实现:http与diohttpClient原生方式主要基于dart:io库中的httpClient来实现:import 'dart:io';var httpClient = new HttpClient();该 client 支持常用_flutter provider 网络请求

java list 内存溢出_java内存溢出的2种情况-程序员宅基地

文章浏览阅读3.2k次,点赞2次,收藏4次。java程序员在面试经常被问到内存om之后如何处理,但是实际在工作中遇到此类问题的情况却又非常少。进过自己一番总结内存溢出主要分为2种:一、堆内存溢出 OutOfMemoryError从jvm的角度看发生的情况是:1、动态扩展的栈内存无法满足内存分配。2、建立新的线程没有足够内存创建栈。从编码角度看发生的情况是:1、内存中加载的数据量过于庞大,如一次从数据库取出过多数据;2、集合类中有对对象的引用..._java中怎么解决list内存溢出

Metamap Java Api 使用教程_metamap使用教程-程序员宅基地

文章浏览阅读5.4k次。Metamap(简称mm)是一个用于识别文本中包含的一体化医学语言系统概念的工具。官网地址:https://mmtx.nlm.nih.gov/mm java api允许通过java程序调用mm的映射引擎,进入mm java api页面(https://mmtx.nlm.nih.gov/JavaApi.shtml)使用mm java api之前需要下载以下工具包:1)_metamap使用教程

STM32F103VET6+keil5+STM32CubeMX 点亮LED灯_stm32f103vet stm32cube-程序员宅基地

文章浏览阅读2k次。STM32F103VET6+keil5+STM32CubeMX 点亮LED灯_stm32f103vet stm32cube

Apk Installer —— 一款Windows下自动关联APK文件且双击APK安装到任意安卓设备上的工具-程序员宅基地

文章浏览阅读5.2k次。Apk Installer介绍Apk Installer(原名:WSAInstallTool,自1.2.3.0版本后更名)是一款Windows下自动关联APK文件且双击APK安装到任意安卓设备上的工具。该软件可以显示Apk自身的图标,详细的权限列表等。支持Windows 11 安卓子系统,支持Windows 7、Windows 10 、Windows 11安装软件至任意安卓设备上。如软件无法运行,请安装.Net Framework 4.5.2。该软件主要服务于Windows 11 的Android子系_apk installer

MicroStation V8i简体中文版完全补丁安装教程(附安装包下载)_microstation v8i 下载-程序员宅基地

文章浏览阅读4.5w次,点赞20次,收藏18次。MicroStation是一款非常不错的二维和三维设计软件,由奔特力(Bentley)工程软件系统有限公司开发的一款软件。在CAD设计上该软件是和AutoCAD是齐名的软件,其专用的文件格式是DGN,当然该软件还兼容AutoCAD的DWG/DXF等格式,该软件的应用已经非常广泛,在建筑、土木工程、交通运输、加工工厂、离散制造业、政府部门、公用事业和电讯网络等领域都有使用到该软件。小编今天带来的是..._microstation v8i 下载