私人工具集6——webapi中的Token功能

原创

已于 2022-02-19 17:31:27 修改 · 2.4k 阅读

7 ·

CC 4.0 BY-SA版权

文章标签：

#c# #token #webapi #asp.net #restful

于 2022-02-16 11:44:18 首次发布

本文详细介绍了如何使用C#实现基于JWT的Token生成、解析及验证过程。通过创建控制器获取Token，使用HMACSHA256算法进行加密和解密，并在API过滤器中进行权限验证。此外，还探讨了Token在WebApi访问控制中的应用。

子曰：工欲善其事，必先利其器

github：https://github.com/redAntCpp/CSharpTools

token的基本原理

token，引用百度百科的话语来说，就是：在计算机身份认证中是令牌（临时）的意思，在词法分析中是标记的意思。一般作为邀请、登录系统使用。
简单理解，在使用系统功能时，如果对安全要求比较高，则需要启动访问控制。举个例子，去电影院看电影，需要电影票。去医院看病，需要出示挂号凭证。
上述的电影票、挂号凭证就可以理解为是一种token。在规定的时间内有效，持此凭证即可使用相应的服务。

基本流程

客户端请求服务端提供token。
服务端产生一个token，并设置token的有效期后，返回给客户端。
客户端持此token，调用服务端的其他服务。

通常，token广泛应用于WebApi的访问控制中。

实现逻辑

下载工具集

在这里插入图片描述

引用工具集

using JWT;
using JWT.Algorithms;
using JWT.Serializers;
using Newtonsoft.Json.Linq;//使用json对象要用到

生成token、解析token帮助类

建立一个帮助类，用来生成token、解析token。假设文件名为tokenHelper。这里实现的是步骤中的第二步。

private static string secret = HOTConfig.GetConfig().GetTokenSecret(); //"GQDstcKsx0NHjPOuXOYg5MbeJ1XT0uFiwDVvVBrk";
        /// <summary>
        /// 生成token
        /// </summary>
        /// <param name="payload">一个json对象，一般是验证信息。对这个json进行加密</param>
        /// <returns></returns>
        public static string SetJwtEncode(JObject payload)
        {
   
   
            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>
        /// 解析token
        /// </summary>
        /// <param name="token">之前生成的token</param>
        /// <returns>返回解析后的结果，这个返回类型必须与加密的入参类型一致。</returns>
        public static JObject GetJwtDecode(string token)
        {
   
   
            IJsonSerializer serializer = new JsonNetSerializer();
            IDateTimeProvider provider = new UtcDateTimeProvider();
            IJwtValidator validator = new JwtValidator(serializer, provider);
            IBase64UrlEncoder urlEncoder = new JwtBase64UrlEncoder();
            var algorithm = new HMACSHA256Algorithm();