kbs super china,闲妻当道,山东交通网
在aspnet core中,自定义jwt管道验证
有了作为基础,那这点也是非常容易的,关键点在中间件,只是把上一级在测试类中的自定义验证放到中间件中来即可,
不过需要注意:中间件 的位置很重要,只有它后面的管道才会收到影响;
那我们先建一个自定义中间件类:(中间件的详细内容这里就不讲了,大家可以参考官网和其他博文)
/// <summary> /// 自定义授权中间件 /// </summary> public class jwtcustomerauthorizemiddleware { private readonly requestdelegate next; public jwtcustomerauthorizemiddleware(requestdelegate next, string secret, list<string> anonymouspathlist) { #region 设置自定义jwt 的秘钥 if(!string.isnullorempty(secret)) { tokencontext.securitykey = secret; } #endregion this.next = next; usercontext.allowanonymouspathlist.addrange(anonymouspathlist); } public async task invoke(httpcontext context, usercontext usercontext,ioptions<jwtoption> optioncontainer) { if (usercontext.isallowanonymous(context.request.path)) { await next(context); return; } var option = optioncontainer.value; #region 身份验证,并设置用户ruser值 var result = context.request.headers.trygetvalue("authorization", out stringvalues authstr); if (!result || string.isnullorempty(authstr.tostring())) { throw new unauthorizedaccessexception("未授权"); } result = tokencontext.validate(authstr.tostring().substring("bearer ".length).trim(), payload => { var success = true; //可以添加一些自定义验证,用法参照测试用例 //验证是否包含aud 并等于 roberaudience success = success && payload["aud"]?.tostring() == option.audience; if (success) { //设置ruse值,把user信息放在payload中,(在获取jwt的时候把当前用户存放在payload的ruser键中) //如果用户信息比较多,建议放在缓存中,payload中存放缓存的key值 usercontext.tryinit(payload["ruser"]?.tostring()); } return success; }); if (!result) { throw new unauthorizedaccessexception("未授权"); } #endregion #region 权限验证 if (!usercontext.authorize(context.request.path)) { throw new unauthorizedaccessexception("未授权"); } #endregion await next(context); } }
上面这个中间件中有个usercontext上线文,这个类主要管理当前用户信息和权限,其他信息暂时不管;我们先看一下这个中间件的验证流程如何:
该中间件主要是针对访问的路径进行验证,当然你也可以针对其他信息进行验证,比如(控制器名称,动作名称,等)
自定义中间件使用jwt验证就这些内容,是不是感觉很清晰,很简单,有木有;
中间已经完成了,那接下来我们来使用它,我们再startup中的configure方法中添加如下代码
app.usemiddleware<jwtcustomerauthorizemiddleware>(configuration["jwtoption:securitykey"], new list<string>() { "/api/values/getjwt","/" });
当然上面可匿名访问的url也可以定义在appsetting.json文件中,可以自行尝试
如何通过自定义策略形式实现自定义jwt验证
创建自定义策略的详细介绍可以参考官网,这里就不详细介绍,
首先我们上代码,创建自定义策略非常重要的两个类,如下:
public class commonauthorizehandler : authorizationhandler<commonauthorize> { /// <summary> /// 常用自定义验证策略,模仿自定义中间件jwtcustomerauthorizemiddleware的验证范围 /// </summary> /// <param name="context"></param> /// <param name="requirement"></param> /// <returns></returns> protected override task handlerequirementasync(authorizationhandlercontext context, commonauthorize requirement) { var httpcontext = (context.resource as authorizationfiltercontext).httpcontext; var usercontext = httpcontext.requestservices.getservice(typeof(usercontext)) as usercontext; var jwtoption = (httpcontext.requestservices.getservice(typeof(ioptions<jwtoption>)) as ioptions<jwtoption>).value; #region 身份验证,并设置用户ruser值 var result = httpcontext.request.headers.trygetvalue("authorization", out stringvalues authstr); if (!result || string.isnullorempty(authstr.tostring())) { return task.completedtask; } result = tokencontext.validate(authstr.tostring().substring("bearer ".length).trim(), payload => { var success = true; //可以添加一些自定义验证,用法参照测试用例 //验证是否包含aud 并等于 roberaudience success = success && payload["aud"]?.tostring() == jwtoption.audience; if (success) { //设置ruse值,把user信息放在payload中,(在获取jwt的时候把当前用户存放在payload的ruser键中) //如果用户信息比较多,建议放在缓存中,payload中存放缓存的key值 usercontext.tryinit(payload["ruser"]?.tostring()); } return success; }); if (!result) { return task.completedtask; } #endregion #region 权限验证 if (!usercontext.authorize(httpcontext.request.path)) { return task.completedtask; } #endregion context.succeed(requirement); return task.completedtask; } } public class commonauthorize: iauthorizationrequirement { }
其中两个重要的类是哪两个呢?他们的作用又是什么呢?
1、commonauthorize: iauthorizationrequirement,至于取什么名字,自己定义,但必须继承iauthorizationrequirement,这类主要是承载一些初始化值,让后传递到handler中去,给验证做逻辑运算提供一些可靠的信息;我这里是空的;自己根据自身情况自己定义适当的属性作为初始数据的承载容器;
2、commonauthorizehandler : authorizationhandler<commonauthorize>这个是重点,承载了验证的逻辑运算
需要重写override task handlerequirementasync方法,所有的逻辑都在该方法中,他的主要逻辑和上面的自定义中间件很相似,只少了上面的第一步;验证流程如下:
3、是不是很简单,和自定义管道验证的的代码几乎一模一样,
如何使用自定义定义策略呢?
1、在startup类中的configureservices中加入如下代码:
services.addauthorization(option => { #region 自定义验证策略 option.addpolicy("common", policy => policy.requirements.add(new commonauthorize())); #endregion }).addauthentication(option => { option.defaultscheme = jwtbearerdefaults.authenticationscheme; }).addjwtbearer(option => { if (!string.isnullorempty(config["jwtoption:securitykey"])) { tokencontext.securitykey = config["jwtoption:securitykey"]; } //设置需要验证的项目 option.tokenvalidationparameters = new tokenvalidationparameters { issuersigningkey = new symmetricsecuritykey(encoding.utf8.getbytes(tokencontext.securitykey))//拿到securitykey }; }); //自定义策略ioc添加 services.addsingleton<iauthorizationhandler, commonauthorizehandler>();
以上代码主要分3个部分
1、添加上面自定义的策略,并取名;
2、设置秘钥,这个秘钥就是上一节中生成jwt的秘钥,必须要要一样,否则是签名不正确
3、注入上面建立的一个重要类commonauthorizehandler,如上面代码
2、在startup类中的configure中添加 app.useauthentication();
3、在需要验证的controller或者action中加上[authorize(policy = "common")]属性,看下图:
到此为止你就可以使用自定义策略的验证了;
使用管道和自定义策略两种形式进行验证有什么区别呢?
从效果上看都是一样的,稍微有点区别
至于你喜欢那种,就使用哪种吧,性能可以忽略不计;
不管使用哪种方式使用jwt作为身份和权限验证是不是很简单,关键这里也把权限验证的逻辑抽出来了,这样代码就更清晰明了了;
至于authorize的属性形式,还有很多其他的策略,比如用户、申明,角色等,可查看官网
下一章将讲解 用户,申明 ,角色的验证,并这些怎么在自定义的验证中实现,以便大家对他有个清晰的对比
总结
以上就是这篇文章的全部内容了,希望本文的内容对大家的学习或者工作具有一定的参考学习价值,如果有疑问大家可以留言交流,谢谢大家对移动技术网的支持。
如对本文有疑问,请在下面进行留言讨论,广大热心网友会与你互动!! 点击进行留言回复
Blazor server side 自家的一些开源的, 实用型项目的进度之 CEF客户端
.NET IoC模式依赖反转(DIP)、控制反转(Ioc)、依赖注入(DI)
vue+.netcore可支持业务代码扩展的开发框架 VOL.Vue 2.0版本发布
网友评论