ASP.NET Core 实战：基于 Jwt Token 的权限控制全揭露
一、前言
在涉及到后端项目的开发中，如何实现对于用户权限的管控是需要我们首先考虑的，在实际开发过程中，我们可能会运用一些已经成熟的解决方案帮助我们实现这一功能，而在 grapefruit.vucore 这个项目中，我将使用 jwt 的方式实现对于用户的权限管控，在本章中，我将演示如何使用 jwt 实现对于用户的授权、鉴权。
系列目录地址：asp.net core 项目实战
仓储地址：https://github.com/lanesra712/grapefruit.vucore
二、step by step
1、一些概念
jwt(json web token)，是一种基于 json 的无状态授权令牌，因为 jwt 是一种标准的数据传输规范，并不是某家所独有的技术规范，因此非常适用于构建单点登录服务，为 web、client、app 等等各种接口使用方提供授权服务。
在使用 jwt 进行权限控制的过程中，我们需要先请求授权服务器获取到 token 令牌，将令牌存储到客户端本地（在 web 项目中，我们可以将 token 存储到 localstorage 或是 cookie 中），之后，对于服务端的每一次请求，都需要将获取到的 token 信息添加到 http 请求的 header 中。
$.ajax({
url: url,
method: "post",
data: json.stringify(data),
beforesend: function (xhr) {
/* authorization header */
xhr.setrequestheader("authorization", "bearer " + token);
},
success: function (data) {}
});
当用户拥有令牌后是否就可以访问系统的所有功能了呢？答案当然否定的。对于一个系统来说可能会有多种用户角色，每一个用户角色可以访问的资源也是不同的，所以，当用户已经拥有令牌后，我们还需要对用户角色进行鉴定，从而做到对用户进行进一步的权限控制。
在 grapefruit.vucore 这个项目中，我采用的是基于策略的授权方式，通过定义一个授权策略来完善 jwt 鉴权，之后将这个自定义策略注入到 iservicecollection 容器中，对权限控制做进一步的完善，从而达到对于用户访问权限的管控。
基于策略的授权是微软在 asp.net core 中添加的一种新的授权方式，通过定义好策略（policy）的一个或多个要求（requirements），将这个自定义的授权策略在 startup.configureservices 方法中作为授权服务配置的一部分进行注册之后即可按照我们的策略处理程序进行权限的控制。
services.addauthorization(options =>
{
options.addpolicy("permission",
policy => policy.requirements.add(new policyrequirement()));
})
services.addsingleton<iauthorizationhandler, policyhandler>();
就像我在后面的代码中一样，我定义了一个名叫 permission 的授权策略，它包含了一个叫做 policyrequirement 的鉴权要求，在实现了授权策略后，将基于这个要求的鉴权方法 policyhandler 以单例（addsingleton）的形式注入到服务集合中，此时，我们就可以在需要添加验证的 controller 上添加 attribute 即可。
[authorize(policy = "permission")]
public class secretcontroller : controllerbase
{}
2、授权
在 grapefruit.vucore 这个项目中，涉及到授权相关的代码所在的位置我已在下图中进行标示。在之前系列开篇文章（asp.net core 实战：使用 asp.net core web api 和 vue.js，搭建前后端分离框架）进行介绍整个项目框架时曾说到， grapefruit.application 是项目的应用层，顾名思义，就是为了实现我们项目中的实际业务功能所划分的类库。因此，我们实现 jwt 的相关业务代码应该位于此层中。同时，因为对于 jwt 的令牌颁发与鉴权，采用的是微软的 jwtbearer 组件，所以我们在使用前需要先通过 nuget 将引用添加到 grapefruit.application 上。
install-package microsoft.aspnetcore.authentication.jwtbearer install-package system.identitymodel.tokens.jwt
在 grapefruit.application 这个类库下我创建了一个 authorization 解决方案文件夹用来存储授权相关的代码。在 authorization 这个解决方案文件夹中包含了两个子文件夹 jwt 和 secret。jwt 文件夹中主要包含我们对于 jwt 的操作，而 secret 文件夹下则是对于用户的相关操作。
每个子应用文件夹（jwt、secret）都包含了相同的结构：dto 数据传输对象、功能接口，以及功能接口的实现类，这里接口的继承采用单继承的方式。
在 jwt 文件夹下创建一个 ijwtappservice 接口文件，在这里定义我们对于 jwt 的相关操作。因为对于 jwt 的授权、鉴权是采用微软的 jwtbearer 组件，我们只需要进行配置即可，所以这里只定义对于 token 的生成、刷新、停用，以及判断这个 token 是否有效这几个方法。同时，我们需要创建 jwtappservice 这个类文件，去继承 ijwtappservice 从而实现接口功能。
public interface ijwtappservice
{
/// <summary>
/// 新增 jwt token
/// </summary>
/// <param name="dto">用户信息数据传输对象</param>
/// <returns></returns>
jwtauthorizationdto create(userdto dto);
/// <summary>
/// 刷新 token
/// </summary>
/// <param name="token">token</param>
/// <param name="dto">用户信息数据传输对象</param>
/// <returns></returns>
task<jwtauthorizationdto> refreshasync(string token, userdto dto);
/// <summary>
/// 判断当前 token 是否有效
/// </summary>
/// <returns></returns>
task<bool> iscurrentactivetokenasync();
/// <summary>
/// 停用当前 token
/// </summary>
/// <returns></returns>
task deactivatecurrentasync();
/// <summary>
/// 判断 token 是否有效
/// </summary>
/// <param name="token">token</param>
/// <returns></returns>
task<bool> isactiveasync(string token);
/// <summary>
/// 停用 token
/// </summary>
/// <returns></returns>
task deactivateasync(string token);
}
jwtauthorizationdto 是一个 token 信息的传输对象，包含我们创建好的 token 相关信息，用来将 token 信息返回给前台进行使用。而 userdto 则是用户登录获取 token 时的数据传输对象，用来接收登录时的参数值。
在创建 token 或是验证 token 时，像 token 的颁发者、接收者之类的信息，因为会存在多个地方调用的可能性，这里我将这些信息存放在了配置文件中，后面当我们需要使用的时候，只需要通过注入 iconfiguration 进行获取即可。关于 jwt 的配置文件主要包含了四项：token 的颁发者，token 的接收者，加密 token 的 key 值，以及 token 的过期时间，你可以根据你自己的需求进行调整。
"jwt": {
"issuer": "yuiter.com",
"audience": "yuiter.com",
"securitykey": "a48fafeefd334237c2ca207e842afe0b",
"expireminutes": "20"
}
在 token 的创建过程中可以简单拆分为三个部分：根据配置信息和用户信息创建一个 token，将加密后的用户信息写入到 httpcontext 上下文中，以及将创建好的 token 信息添加到静态的 hashset<jwtauthorizationdto> 集合中。
在 token 创建、校验的整个生命周期中，都涉及到了 scheme、claim、claimsidentity、claimsprincipal 这些概念，如果你之前有使用过微软的 identity 权限验证，对于这几个名词就会比较熟悉，可能某些小伙伴之前并没有使用过 identity，我来简单介绍下这几个名词的含义。
scheme 模式，这个与其余的名词相对独立，它主要是指明我们是以什么授权方式进行授权的。例如，你是以 cookie 的方式授权或是以 openid 的方式授权，或是像这里我们使用 jwt bearer 的方式进行授权。
claim 声明，以我们的现实生活为例，我们每个人都会有身份证，上面会包含我们的姓名、性别、民族、出生日期、家庭住址、身份证号，每一项数据的都可以看成是 type-value（数据类型-数据值），例如，姓名：张三。身份证上的每一项的信息就是我们的 claim 声明，姓名：张三，是一个 claim；性别：男，也是一个 claim。而对于 claimsidentity，就像这一项项的信息最终组成了我们的身份证，这一项项的 claim 最终组成了我们的 claimsidentity。而 claimsprincipal 则是 claimsidentity 的持有者，就像我们拥有身份证一样。
从上面的文字可以总结出，claim（每一项的证件信息）=》claimsidentity（证件）=》claimsprincipal（证件持有者）。其中，一个 claimsidentity 可以包含多个的 claim，而一个 claimsprincipal 可以包含多个的 claimsidentity。
如果想要深入了解 asp.net core 的授权策略的可以看看园子里这篇文章 =》asp.net core 运行原理解剖[5]:authentication，或是国外的这篇介绍 asp.net core 授权的文章 =》introduction to authentication with asp.net core。
实现 token 生成的最终代码实现如下所示，可以看到，在创建 claimsidentity “证件”信息时，我添加了用户的角色信息，并把加密后的用户信息写入到 httpcontext 上下文中，这样，我们在后面验证的时候就可以通过 httpcontext 获取到用户的角色信息，从而判断用户是否可以访问当前请求的地址。
/// <summary>
/// 新增 token
/// </summary>
/// <param name="dto">用户信息数据传输对象</param>
/// <returns></returns>
public jwtauthorizationdto create(userdto dto)
{
jwtsecuritytokenhandler tokenhandler = new jwtsecuritytokenhandler();
symmetricsecuritykey key = new symmetricsecuritykey(encoding.utf8.getbytes(_configuration["jwt:securitykey"]));
datetime authtime = datetime.utcnow;
datetime expiresat = authtime.addminutes(convert.todouble(_configuration["jwt:expireminutes"]));
//将用户信息添加到 claim 中
var identity = new claimsidentity(jwtbearerdefaults.authenticationscheme);
ienumerable<claim> claims = new claim[] {
new claim(claimtypes.name,dto.username),
new claim(claimtypes.role,dto.role.tostring()),
new claim(claimtypes.email,dto.email),
new claim(claimtypes.expiration,expiresat.tostring())
};
identity.addclaims(claims);
//签发一个加密后的用户信息凭证，用来标识用户的身份
_httpcontextaccessor.httpcontext.signinasync(jwtbearerdefaults.authenticationscheme, new claimsprincipal(identity));
var tokendescriptor = new securitytokendescriptor
{
subject = new claimsidentity(claims),//创建声明信息
issuer = _configuration["jwt:issuer"],//jwt token 的签发者
audience = _configuration["jwt:audience"],//jwt token 的接收者
expires = expiresat,//过期时间
signingcredentials = new signingcredentials(key, securityalgorithms.hmacsha256)//创建 token
};
var token = tokenhandler.createtoken(tokendescriptor);
//存储 token 信息
var jwt = new jwtauthorizationdto
{
userid = dto.id,
token = tokenhandler.writetoken(token),
auths = new datetimeoffset(authtime).tounixtimeseconds(),
expires = new datetimeoffset(expiresat).tounixtimeseconds(),
success = true
};
_tokens.add(jwt);
return jwt;
}
当创建好 token 之后，客户端就可以在 http 请求的 header 中添加 token 信息，从而访问受保护的资源。不过，在某些情况下，比如说，用户修改了密码之后，虽然当前的 token 信息可能还未过期，但我们也不能允许用户再使用当前的 token 信息进行接口的访问，这时，就涉及到了对于 token 信息的停用以及刷新。
这里我采用是当我们停用 token 信息时，将停用的 token 信息添加到 redis 缓存中，之后，在用户请求时判断这个 token 是不是存在于 redis 中即可。
当然，你也可以在停用当前用户的 token 信息时，将 hashset 中的这个 token 信息进行删除，之后，通过判断访问时的 token 信息是否在 hashset 集合中，判断 token 是否有效。
方法很多，看你自己的需求了。
对于 redis 的读写操作，我是使用微软的 redis 组件进行的，你可以按照你的喜好进行修改。如果你和我一样，采用这个组件，你需要在 grapefruit.application 这个类库中通过 nuget 添加微软的分布式缓存抽象接口 dll 的引用，以及在 grapefruit.webapi 项目中添加微软的 redis 实现。
install-package microsoft.extensions.caching.abstractions ## 分布式缓存抽象接口 install-package microsoft.extensions.caching.redis ## redis 实现
当我们停用 token 时，通过 httpcontext 上下文获取到 http header 中的 token 信息，将该 token 信息存储到 redis 缓存中，这样，我们就完成了对于 token 的停用。
public class jwtappservice : ijwtappservice
{
/// <summary>
/// 停用 token
/// </summary>
/// <param name="token">token</param>
/// <returns></returns>
public async task deactivateasync(string token)
=> await _cache.setstringasync(getkey(token),
" ", new distributedcacheentryoptions
{
absoluteexpirationrelativetonow =
timespan.fromminutes(convert.todouble(_configuration["jwt:expireminutes"]))
});
/// <summary>
/// 停用当前 token
/// </summary>
/// <returns></returns>
public async task deactivatecurrentasync()
=> await deactivateasync(getcurrentasync());
/// <summary>
/// 设置缓存中过期 token 值的 key
/// </summary>
/// <param name="token">token</param>
/// <returns></returns>
private static string getkey(string token)
=> $"deactivated token:{token}";
/// <summary>
/// 获取 http 请求的 token 值
/// </summary>
/// <returns></returns>
private string getcurrentasync()
{
//http header
var authorizationheader = _httpcontextaccessor
.httpcontext.request.headers["authorization"];
//token
return authorizationheader == stringvalues.empty
? string.empty
: authorizationheader.single().split(" ").last();// bearer tokenvalue
}
}
对于 token 的刷新，其实我们就可以看成重新生成了一个 token 信息，只不过我们需要将之前的 token 信息进行停用。
public class jwtappservice : ijwtappservice
{
/// <summary>
/// 刷新 token
/// </summary>
/// <param name="token">token</param>
/// <param name="dto">用户信息</param>
/// <returns></returns>
public async task<jwtauthorizationdto> refreshasync(string token, userdto dto)
{
var jwtold = getexistencetoken(token);
if (jwtold == null)
{
return new jwtauthorizationdto()
{
token = "未获取到当前 token 信息",
success = false
};
}
var jwt = create(dto);
//停用修改前的 token 信息
await deactivatecurrentasync();
return jwt;
}
/// <summary>
/// 判断是否存在当前 token
/// </summary>
/// <param name="token">token</param>
/// <returns></returns>
private jwtauthorizationdto getexistencetoken(string token)
=> _tokens.singleordefault(x => x.token == token);
}
至此，我们对于 token 的创建、刷新、停用的代码就已经完成了，接下来，我们来实现对于 token 信息的验证。ps：下面的代码如无特殊说明外，均位于 startup 类中。
3、鉴权
在 asp.net core 应用中，依赖注入随处可见，而我们对于我们的功能方法的使用，也是采用依赖注入到容器，通过功能接口进行调用的方式。因此，我们需要将我们的接口与其实现类注入到 iservicecollection 容器中。这里，我们采用反射的方式，批量的将程序集内的接口与其实现类进行注入。
public void configureservices(iservicecollection services)
{
assembly assembly = assembly.load("grapefruit.application");
foreach (var implement in assembly.gettypes())
{
type[] interfacetype = implement.getinterfaces();
foreach (var service in interfacetype)
{
services.addtransient(service, implement);
}
}
}
因为基础的权限验证我们是采用的微软的 jwtbearer 权限验证组件进行的授权和鉴权，因此对于 token 信息的基础鉴权操作，只需要我们在中间件中进行配置即可。同时，我们也在 ijwtappservice 接口中定义了对于 token 信息的一些操作，而对于我们自定义的权限验证策略，则需要通过基于策略的授权方式进行实现。
首先，我们需要先定义一个继承于 iauthorizationrequirement 的自定义授权要求类 policyrequirement。在这个类中，你可以定义一些属性，通过有参构造函数的方式进行构造，这里我不定义任何的属性，仅是创建这个类。
public class policyrequirement : iauthorizationrequirement
{ }
当我们创建好 policyrequirement 这个权限要求类后，我们就可以通过继承 authorizationhandler 来实现我们的授权逻辑。这里实现权限控制的代码逻辑，主要是通过重写 handlerequirementasync 方法来实现的。
protected override async task handlerequirementasync(authorizationhandlercontext context, policyrequirement requirement)
{
//todo：获取角色、url 对应关系
list<menu> list = new list<menu> {
new menu
{
role = guid.empty.tostring(),
url = "/api/v1.0/values"
},
new menu
{
role=guid.empty.tostring(),
url="/api/v1.0/secret/deactivate"
},
new menu
{
role=guid.empty.tostring(),
url="/api/v1.0/secret/refresh"
}
};
var httpcontext = (context.resource as authorizationfiltercontext).httpcontext;
//获取授权方式
var defaultauthenticate = await schemes.getdefaultauthenticateschemeasync();
if (defaultauthenticate != null)
{
//验证签发的用户信息
var result = await httpcontext.authenticateasync(defaultauthenticate.name);
if (result.succeeded)
{
//判断是否为已停用的 token
if (!await _jwtapp.iscurrentactivetokenasync())
{
context.fail();
return;
}
httpcontext.user = result.principal;
//判断角色与 url 是否对应
//
var url = httpcontext.request.path.value.tolower();
var role = httpcontext.user.claims.where(c => c.type == claimtypes.role).firstordefault().value;
var menu = list.where(x => x.role.equals(role) && x.url.tolower().equals(url)).firstordefault();
if (menu == null)
{
context.fail();
return;
}
return;
}
}
context.fail();
}
在判断用户是否可以访问当前的请求地址时，首先需要获取到用户角色与其允许访问的地址列表，这里我使用的是模拟的数据。通过判断当前登录用户的角色是否包含请求的地址，当用户的角色并不包含对于访问地址的权限时，返回 403 forbidden 状态码。
这里需要注意，如果你准备采取 restful 风格的 api，因为请求的地址是相同的，你需要添加一个 http 谓词参数用来指明所请求的方法，从而达到访问权限管控的目的。。
包含 token 的基础验证的授权配置的代码如下所示。在中间件进行 jwt 验证的过程中，会验证授权方式是不是 bearer 以及通过 token 的属性解密之后与生成时用户数据进行比对，从而判断这个 token 是否有效。
public void configureservices(iservicecollection services)
{
string issuer = configuration["jwt:issuer"];
string audience = configuration["jwt:audience"];
string expire = configuration["jwt:expireminutes"];
timespan expiration = timespan.fromminutes(convert.todouble(expire));
securitykey key = new symmetricsecuritykey(encoding.utf8.getbytes(configuration["jwt:securitykey"]));
services.addauthorization(options =>
{
//1、definition authorization policy
options.addpolicy("permission",
policy => policy.requirements.add(new policyrequirement()));
}).addauthentication(s =>
{
//2、authentication
s.defaultauthenticatescheme = jwtbearerdefaults.authenticationscheme;
s.defaultscheme = jwtbearerdefaults.authenticationscheme;
s.defaultchallengescheme = jwtbearerdefaults.authenticationscheme;
}).addjwtbearer(s =>
{
//3、use jwt bearer
s.tokenvalidationparameters = new tokenvalidationparameters
{
validissuer = issuer,
validaudience = audience,
issuersigningkey = key,
clockskew = expiration,
validatelifetime = true
};
s.events = new jwtbearerevents
{
onauthenticationfailed = context =>
{
//token expired
if (context.exception.gettype() == typeof(securitytokenexpiredexception))
{
context.response.headers.add("token-expired", "true");
}
return task.completedtask;
}
};
});
//di handler process function
services.addsingleton<iauthorizationhandler, policyhandler>();
}
因为我们是使用 swagger 进行的 api 文档的可视化，这里，我们继续配置 swagger 从而使 swagger 可以支持我们的权限验证方式。
public void configureservices(iservicecollection services)
{
services.addswaggergen(s =>
{
//add jwt authorize to http header
s.addsecuritydefinition("bearer", new apikeyscheme
{
description = "jwt authorization header using the bearer scheme. example: \"authorization: bearer {token}\"",
name = "authorization",//jwt default param name
in = "header",//jwt store address
type = "apikey"//security scheme type
});
//add authentication type
s.addsecurityrequirement(new dictionary<string, ienumerable<string>>
{
{ "bearer", new string[] { } }
});
});
}
在停用 token 的代码中，我们使用了 redis 去保存停用的 token 信息，因此，我们需要配置我们的 redis 连接。
public void configureservices(iservicecollection services)
{
services.adddistributedrediscache(r =>
{
r.configuration = configuration["redis:connectionstring"];
});
}
现在，整个业务相关的代码已经完成了，我们可以创建前端访问的接口了。这里我是在 controllers 下的 v1 文件夹下创建了一个 secretcontroller 用来构建前端访问的接口。控制器中主要有三个方法，分别为 cancelaccesstoken（停用 token）、login（获取 token）以及 refreshaccesstokenasync（刷新 token）。
public class secretcontroller : controllerbase
{
/// <summary>
/// 停用 jwt 授权数据
/// </summary>
/// <returns></returns>
[httppost("deactivate")]
public async task<iactionresult> cancelaccesstoken()
{
await _jwtapp.deactivatecurrentasync();
return ok();
}
/// <summary>
/// 获取 jwt 授权数据
/// </summary>
/// <param name="dto">授权用户信息</param>
[httppost("token")]
[allowanonymous]
public iactionresult login([frombody] secretdto dto)
{
//todo：获取用户信息
var user = new userdto
{
id = guid.newguid(),
username = "yuiter",
role = guid.empty,
email = "yuiter@yuiter.com",
phone = "13912345678",
};
if (user == null)
return ok(new jwtresponsedto
{
access = "无权访问",
type = "bearer",
profile = new profile
{
name = dto.account,
auths = 0,
expires = 0
}
});
var jwt = _jwtapp.create(user);
return ok(new jwtresponsedto
{
access = jwt.token,
type = "bearer",
profile = new profile
{
name = user.username,
auths = jwt.auths,
expires = jwt.expires
}
});
}
/// <summary>
/// 刷新 jwt 授权数据
/// </summary>
/// <param name="dto">刷新授权用户信息</param>
/// <returns></returns>
[httppost("refresh")]
public async task<iactionresult> refreshaccesstokenasync([frombody] secretdto dto)
{
//todo：获取用户信息
var user = new userdto
{
id = guid.newguid(),
username = "yuiter",
role = guid.empty,
email = "yuiter@yuiter.com",
phone = "13912345678",
};
if (user == null)
return ok(new jwtresponsedto
{
access = "无权访问",
type = "bearer",
profile = new profile
{
name = dto.account,
auths = 0,
expires = 0
}
});
var jwt = await _jwtapp.refreshasync(dto.token, user);
return ok(new jwtresponsedto
{
access = jwt.token,
type = "bearer",
profile = new profile
{
name = user.username,
auths = jwt.success ? jwt.auths : 0,
expires = jwt.success ? jwt.expires : 0
}
});
}
}
现在，让我们测试一下，从下图中可以看到，当我们未获取 token 时，访问接口提示我们 401 unauthorized，当我们模拟登录获取到 token 信息后，再次访问受保护的资源时，已经可以获取到响应的数据。之后，当我们刷新 token，此时再用原来的 token 信息访问时，已经无法访问，提示 403 forbidden，同时，可以看到我们的 redis 中已经存在了停用的 token 信息，此时，使用新的 token 信息又可以访问了。
至此，整个的 jwt 授权鉴权相关的代码就已经完成了，因为篇幅原因，完整的代码请到 github 上进行查看（电梯直达）。ps：因为博客园允许上传的图片限制最大尺寸为 10m，所以这里上传的 gif 是压缩后的，见谅见谅，如果有需要查看清晰的图片，欢迎到我的个人博客上查看（）。
三、总结
本章，主要是使用 jwt 完成对于用户的授权与鉴权，实现了对于用户 token 令牌的创建、刷新、停用以及校验。在实际的开发中，采用成熟的*可能是更好的方案，如果你有针对 jwt 进行用户授权、鉴权更好的解决方案的话，欢迎你在评论区留言指出。拖了很久，应该是年前的最后一篇了，提前祝大家新年快乐哈~~~
上一篇： 相互宝新推出家庭保障功能 还享专属福利