IdentityServer4客户端如何获取自定义声明,了解一下?
前言
久违了各位,之前录制过IdentityServer4的基础视频(https://space.bilibili.com/319652230/#/),有兴趣了解的童鞋可以看一下,只不过未发表成博客。我们使用IdentityServer4结和ASP.NET Identity来进行用户的认证和授权管理,在实际项目中我们都会继承ASP.NET Core Identity中IdentityUser类即用户实体,并添加我们自定义的扩展属性,在客户端(Clients)中我们只能拿到用户Id,但是若我们要获取用户中其他重要的属性,此时相对于IdentityServer4而言则需要自定义声明,那么在IdentityServer4中如何添加自定义声明并在客户端中能正确获取到呢?本文详细讲解一下,对于IdentityServer4我也是初学者,仅仅止于知道和使用而已,若有错误的地方,还请大佬指正。
IdentityServer4添加自定义声明(方式一)
首先我们继承自IdentityUser类并添加额外的属性比如部门Id,如下:
public class OnLineBookIdentityUser : IdentityUser
{
public string DepartmentId { get; set; }
}
接下来我们需要将部门Id通过IdentityServer4添加到声明中,在IdentityServer4中添加自定义声明我们需要实现IProfileService接口,该接口有如下两个方法。
我们实现上述两个方法,在第一个方法中参数也就是用户基本信息上下文中拿到用户Id即Subject,然后我们定义用户中的部门Id属性为idr,并将用户中的部门Id属性映射到声明的idr中,最终实现如下:
public class ProfileService : IProfileService
{
protected UserManager<OnLineBookIdentityUser> _userManager; public ProfileService(UserManager<OnLineBookIdentityUser> userManager)
{
_userManager = userManager;
} public Task GetProfileDataAsync(ProfileDataRequestContext context)
{
var user = _userManager.GetUserAsync(context.Subject).Result; var claims = new List<Claim>
{
new Claim("idr", user.DepartmentId),
}; context.IssuedClaims.AddRange(claims);
return Task.FromResult();
} public Task IsActiveAsync(IsActiveContext context)
{
var user = _userManager.GetUserAsync(context.Subject).Result;
context.IsActive = true;
return Task.FromResult();
}
}
接下来在注入IdentityServer4时,添加我们自定义实现的ProfileService,更多基础请参考IdentityServer4官网以及我所录制的IdentityServer4基础视频。
//注入IdentityServer4使用AspNetIdentity
services.AddIdentityServer(options =>
{
options.Authentication.CookieLifetime = TimeSpan.FromMinutes();
})
.AddDeveloperSigningCredential()
.AddAspNetIdentity<OnLineBookIdentityUser>()
....
.AddProfileService<ProfileService>();
晓晨姐姐在他发表的博客文章(http://www.cnblogs.com/stulzq/p/8726002.html)中说必须还要实现IResourceOwnerPasswordValidator接口,那么在客户端获取到自定义声明应该是通过调用接口的方式获取用户自定义声明(不知是否理解正确或者说通过客户端中User中Principal获取到呢?)这里我们并未实现上述IResourceOwnerPasswordValidator接口,我们看看在客户端是否能拿到上述我们声明的idr呢?在客户端我们定义如下控制器,访问需要进行授权,并获取我们添加的自定义声明idr,如下:
[Route("[controller]"), Authorize]
public class OrderController : Controller
{
private readonly IOrderService _orderService;
public OrderController(IOrderService orderService)
{
_orderService = orderService;
} [HttpGet("index")]
public IActionResult Index()
{
var idr = User.FindFirst("idr")?.Value;
return View(nameof(Index), idr);
}
}
并在上述index视图中我们答应自定义声明idr所对应的部门的值,如下:
@model string
@if (Model is null)
{ <h1>idr is null</h1>
}
else
{
<h1>@Model.ToString()</h1>
}
接下来我们通过动态gif来演示下,注意如下视频http://localhost:5000/为IdentityServer4认证、授权服务器端。而http://localhost:5003/为客户端。
上述我们可以看到在登录之后重定向到客户端,我们拿到ack即AccessToken里面有自定义声明idr,但是当我们访问Order/Index并未获取到idr,这是为何,这是因为我们通过如下即ClaimPrincipal去获取idr时,实际上是获取的id_token里面的用户信息,而不是AccessToken,而id_token我们看到没有idr,所以才出现没有获取到的情况。
var idr = User.FindFirst("idr")?.Value;
为了解决这个问题,我们可以在通过IdentityServer4创建的Clients表中所对应的调用客户端中的如下列设置为True即可。
接下来我们再来演示一下,此时我们将看到解析通过id_token将返回idr,并能在客户端读取到idr。
IdentityServer4添加自定义声明(方式二)
除了上述方式通过实现ProfileService接口外,我们还可以通过实现自定义UserClaimsPrincipalFactory工厂类来实现,复写CreateAsync方法来创建自定义声明如下:
public class CustomizeUserClaimsFactory<TRole> : UserClaimsPrincipalFactory<OnLineBookIdentityUser, TRole>
where TRole : class
{
public CustomizeUserClaimsFactory(UserManager<OnLineBookIdentityUser> userManager, RoleManager<TRole> roleManager, IOptions<IdentityOptions> optionsAccessor)
: base(userManager, roleManager, optionsAccessor)
{
} public async override Task<ClaimsPrincipal> CreateAsync(OnLineBookIdentityUser user)
{
var cliamsPrincipal = await base.CreateAsync(user);
var identity = cliamsPrincipal.Identities.First(); if (!identity.HasClaim(x => x.Type == "idr"))
{
identity.AddClaim(new Claim("idr", user.DepartmentId));
} return cliamsPrincipal;
}
}
然后通过创建扩展方法将上述自定义用户声明工厂进行注入,如下:
public static IdentityBuilder AddCustomizeUserClaimsPrincipalFactory(this IdentityBuilder builder)
{
var interfaceType = typeof(IUserClaimsPrincipalFactory<>);
interfaceType = interfaceType.MakeGenericType(builder.UserType); var classType = typeof(CustomizeUserClaimsFactory<>);
classType = classType.MakeGenericType(builder.RoleType); builder.Services.AddScoped(interfaceType, classType); return builder;
}
最后在注入Identity时,添加上述自定义声明工厂,如下:
services.AddIdentity<OnLineBookIdentityUser, IdentityRole>()
.AddEntityFrameworkStores<OnLineBookDbContext>()
.AddDefaultTokenProviders()
.AddCustomizeUserClaimsPrincipalFactory();
总结
本节内容需要有一定IdentityServer4基础,如若不太了解请参考官方文档,同时针对如上在客户端如何获取自定义声明,重点在于在对应客户端表中设置AlwaysIncludeInIdToken为True才好使,并未去深究设置该列为True所产生的副作用,感谢阅读,若有不同见解,望留下您的评论。
IdentityServer4客户端如何获取自定义声明,了解一下?的更多相关文章
- [asp.net mvc 奇淫巧技] 01 - 封装上下文 - 在View中获取自定义的上下文
我们在asp.net 开发中已经封装了最强大的HttpContext,我们可以在HttpContext中可以获取到几乎任何想获取的东西,也可以在HttpContext写入需要返回客户端的信息.但是这些 ...
- AOP中获取自定义注解的参数值
目录 一.利用注解实现AOP的基本流程 1.1.创建一个注解,用来注解切点(pointcut) 1.2.创建一个service,使用上面定义的注解来指定切点 1.3.创建Aspect,增加业务逻辑 ...
- iOS开发小技巧--获取自定义的BarButtonItem中的自定义View的方法(customView)
如果BarButtonItem是通过[[UIBarButtonItem alloc] initWithCustomView:(nonnull UIView *)]方法设置的.某些情况下需要修改BarB ...
- .net c#获取自定义Attribute
前言: 在c#开发中,有时候我们需要读取 Attribute中的信息(关于Attribute , 我自己把他理解成一个可以为类,属性标记的东西,这个标记可以为你提供一些关于类,方法,属性的额外信息) ...
- C# 如何获取自定义的config中节点的值,并修改节点的值
现定义一个方法 DIYConfigHelper.cs using System; using System.Xml; using System.Configuration; using System. ...
- day05 Spring中自定义注解的用处-之获取自定义的Servie
PS: 在RPC远程调用中,想要获取自定义的service的方法,就得自定义标签遍历拿到方法 PS:在spring中,两个最核心的 概念是aop和ioc,aop其实就是动态代理. ioc 就是解决对象 ...
- java反射机制获取自定义注解值和方法
由于工作需求要应用到java反射机制,就做了一下功能demo想到这些就做了一下记录 这个demo目的是实现动态获取到定时器的方法好注解名称,废话不多说了直接上源码 1.首先需要自定义注解类 /** * ...
- js ajax设置和获取自定义header信息的方法总结
目录 1.js ajax 设置自定义header 1.1 方法一: 1.2 方法二: 2.js ajax 获取请求返回的response的header信息 3.js ajax 跨域请求的情况下获取自定 ...
- AntDesign getFieldDecorator 获取自定义组件的值
AntDesign getFieldDecorator 获取自定义组件的值 1.自定义或第三方的表单控件,也可以与 Form 组件一起使用.只要该组件遵循以下的约定: (1)提供受控属性 value ...
随机推荐
- #Java学习之路——基础阶段二(第四篇)
我的学习阶段是跟着CZBK黑马的双源课程,学习目标以及博客是为了审查自己的学习情况,毕竟看一遍,敲一遍,和自己归纳总结一遍有着很大的区别,在此期间我会参杂Java疯狂讲义(第四版)里面的内容. 前言: ...
- 微信公众号开发C#系列-6、消息管理-普通消息接受处理
1.概述 通过前面章节的学习,我们已经对微信的开发有了基本的掌握与熟悉,基本可以上手做复杂的应用了.本篇我们将详细讲解微信消息管理中普通消息的接收与处理.当普通微信用户向公众账号发消息时,微信服务器将 ...
- WPF 添加 Resources Dictionary 资源 一般类库项目中无法添加资源文件(ResourceDictionary)
在文件夹或者项目右键-> Add(添加),会弹出可以快捷添加的资源,但是你会发现没有 ResourceDictionary资源可以选择. 解决此问题方法: 第一步:工程->右键->U ...
- c#解决TCP“粘包”问题
一:TCP粘包产生的原理 1,TCP粘包是指发送方发送的若干包数据到接收方接收时粘成一包,从接收缓冲区看,后一包数据的头紧接着前一包数据的尾.出现粘包现象的原因是多方面的,它既可能由发送方造成,也可能 ...
- Java学习点滴——Class和反射
基于<Java编程思想>第四版 前言 我们要操作一个类实例对象时,一般都要先知道这个类有哪些方法或者成员变量.反射就是在我们不知道这个类有哪些方法或成员变量时,使用特定方式得到类的这些信息 ...
- python3 Flask -day2
flask 实战第二天,url传参 当我们访问网站/的时候,会执行hell_world函数,并把这个函数的返回值返回给浏览器,这样浏览器就显示hello world了 @app.route('/') ...
- 微信小程序 picker 中range-key的坑
<picker class='fr' bindchange="onChangeBuild" range-key="{{'num'}}" value=&qu ...
- 微擎模块的安装文件manifest.xml
微擎在安装或卸载模块时会根据manifest.xml生成(或删除)数据库中相应记录,并执行manifest.xml里指定的脚本. manifest.xml文件内容详细介绍如下: manifest - ...
- Vue基础知识
Vue特性: 双向数据绑定 通过 指令 扩展了 HTML,通过 表达式 绑定数据到 HTML 解耦视图与数据 可复用组件 虚拟DOM -> 对象 M-V-VM 数据驱动视图 Vue声明周期: b ...
- div在另一个div居中对齐
position:fixed; top:0; right:0; left:0; bottom:0; margin:auto;