本文学习并记录builder.Services.AddAuthentication().AddJwtBearer函数中配置类的主要属性及用途。AddJwtBearer函数原型如下图所示,划红线的为常用形式,主要设置JwtBearerOptions类型的常用属性或事件。
JwtBearerOptions类中的属性虽多,但从参考文献的示例来看,大多没有直接设置,主要是对TokenValidationParameters属性设置,该属性与Token验证息息相关,除此之外,参考文献4中还设置了Events属性,该属性类型为JwtBearerEvents,可以处理Token验证时的各类事件,如下图所示:
JwtBearerOptions.TokenValidationParameters的类型为TokenValidationParameters,其常用的属性如下表所示:
序号 | 属性 | 说明 |
---|---|---|
1 | ClockSkew | 设置或获取时间验证时的时间漂移,默认为300秒,根据参考文献9中的解释,该属性用于处理生成Token和验证Token的服务器之间的可能的时间不同步问题,也即两个时间的误差在ClockSkew范围内即可认为是验证通过 |
2 | IssuerSigningKey | 类型为SecurityKey,保存签证Token签名时所需的密钥 |
3 | NameClaimType | string类型,设置有效负载中的name声明的默认类型,也即保存姓名的键值对中的默认键值,一般都使用默认值 |
4 | PropertyBag | IDictionary<string, object>,保存有效负载中自定义声明信息的键值对,以支持自定义声明信息的验证 |
5 | RequireExpirationTime | bool类型,默认值为true,标志有效负载中是否要存在到期时间声明,也即有类型为exp的键值对 |
6 | RoleClaimType | string类型,设置有效负载中的role声明的默认类型,也即保存角色的键值对中的默认键值,一般都使用默认值 |
7 | ValidAudience | string类型,设置有效受众(Audience),以便需验证受众时与有效负载中的声明信息进行对比 |
8 | ValidAudiences | IEnumerable类型,保存有多个有效受众,验证受众时只要存在aud类型声明信息,且值在集合内即可通过验证 |
9 | ValidIssuer | string类型,设置有效发行者(Issuer),以便需验证发行者时与有效负载中的声明信息进行对比 |
10 | ValidIssuers | Enumerable类型,保存有多个有效发行者,验证发行者时只要存在iss类型声明信息,且值在集合内即可通过验证 |
11 | ValidateIssuer | bool类型,默认值为true,设置验证Token时是否验证有效负载中的发行者声明是否与验证程序中的一致 |
12 | ValidateAudience | bool类型,默认值为true,设置验证Token时是否验证有效负载中的受众声明是否与验证程序中的一致 |
13 | ValidateLifetime | bool类型,默认值为true,设置验证Token的声明周期,也即是否超过Token中指定的过期时间+ClockSkew |
TokenValidationParameters中的其它属性大多是代理函数声明,用于在特定应用场景中替换微软JwtBearer中默认的处理函数。
参考文献:
[1]https://www.jianshu.com/p/a2804e72d296
[2]https://blog.csdn.net/sD7O95O/article/details/85043160
[3]https://www.cnblogs.com/qiongkangle/p/13347283.html
[4]https://www.cnblogs.com/xbhp/p/17401507.html
[5]https://www.cnblogs.com/superstar/p/16491428.html
[6]https://blog.csdn.net/weixin_44877917/article/details/140609294
[7]https://blog.csdn.net/qq_40287041/article/details/143368882
[9]https://blog.csdn.net/kan_kongzhizhen/article/details/138670376