.netCore下的jwt的梳理-->借鉴于“老张的哲学”
之前在公司的项目中有用到jwt进行token验证,但是公司里用的框架已经集成好了jwt,所以对jwt的的了解不够清晰,感觉还是隔着一层。在看了“老张的哲学”的jwt部分后对jwt的认识才更加深刻了一些,这篇文章主要是自己对知识的一个梳理。
- Jwt的介绍
- swagger中启用jwt
- 配置jwt官方认证
- 例子
1、jwt的组成
jwt通常由三部分组成,(1)头部 Header、(2)消息载体 payload、(3)签名 signature 由.号隔开三部分 例如
eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiYWRtaW4iOnRydWV9.TJVA95OrM7E2cBab30RMHrHDcEfxjoYZgeFONFh7HgQ
1)Header一般由两个部分组成:alg和typ
alg
是所使用的hash算法,如:HMAC SHA256或RSA,typ
是Token的类型,在这里就是:JWT,然后使用Base64Url编码成第一部分:
eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.
{
"alg": "HS256",
"typ": "JWT"
}
2)payload这一部分是JWT主要的信息存储部分,主要由各种claims(声明/信息)组成
在JwtRegisteredClaimNames(微软预先定义的)类中包含了一些常用的信息,例如:Jti(编号)、Iat(签发时间)、Exp(过期时间)、Iss(签发人)、Aud(订阅者)等
一个简单的Pyload可以是这样子的,同样使用Base64Url编码成第二部分::
eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiYWRtaW4iOnRydWV9.
{
"sub": "1234567890",
"name": "John Doe",
"admin": true
}
3)signature 签名,通过服务端的密钥生成,用来验证生成的jwt是不是有效的,最后生成的jwt
eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiYWRtaW4iOnRydWV9.TJVA95OrM7E2cBab30RMHrHDcEfxjoYZgeFONFh7HgQ
2、Swagger中启用jwt
注意是swagger服务内部
api文档用的是swagger,所以还需要在startup里的swagger配置中启用jwt的配置,swagger的具体配置使用就不放在这边,准备以后结合公司的方式在补充一篇。
在ConfigureServices下的swagger中配置jwt
#region Swagger services.AddSwaggerGen(c =>
{
#region swagger的配置 c.SwaggerDoc("v1",new Info
{
Version = "v0.1.0",
Title = "Blog.Core API",
Description = "框架说明文档"
});
var basePath = Microsoft.DotNet.PlatformAbstractions.ApplicationEnvironment.ApplicationBasePath;
var xmlPath = Path.Combine(basePath, "Blog.Core.xml");
c.IncludeXmlComments(xmlPath,true);//默认的第二个参数是false,这个是controller的注释,记得修改 var xmlModelPath = Path.Combine(basePath, "Blog.Core.Model.xml");
c.IncludeXmlComments(xmlModelPath);
#endregion #region swagger 中开启jwt认证
//添加header验证信息
var security = new Dictionary<string, IEnumerable<string>> { { "Blog.Core", new string[] { } } };
c.AddSecurityRequirement(security);
c.AddSecurityDefinition("Blog.Core", new ApiKeyScheme
{
Description = "JWT授权(数据将在请求头中进行传输) 直接在下框中输入Bearer {token}(注意两者之间是一个空格)",
Name = "Authorization",
In = "header",
Type = "apiKey"
}); #endregion }); #endregion
3、配置官方jwt
在swagger开启jwt认证后,还需要配置jwt中间件(用来解析收到jwt是否有效),我用的官方默认配置
在appsettings.json中的配置(可以改进,感觉还是根据环境变量配置比较好即放入(appsettings.Development.json)文件中,中间的Development根据环境改变)
"Audience": {
"Secret": "sdfsdfsrty45634kkhllghtdgdfss345t678fs", //不要太短,请注意!!!16+
"SecretFile": "C:\\my-file\\blog.core.audience.secret.txt",
"Issuer": "Blog.Core",
"Audience": "wr"
}
在ConfigureServices中配置
#region jwt 官方认证
//密钥的生成
var audienceConfig = Configuration.GetSection("Audience");
var symmetricKeyAsBase64 = audienceConfig["Secret"]; //从配置中读取密钥 注意:密钥长度需要大于16位
var KeyByteArray = Encoding.UTF8.GetBytes(symmetricKeyAsBase64);
var signingKey = new SymmetricSecurityKey(KeyByteArray); // 令牌验证参数
var tokenValidationParameters = new TokenValidationParameters
{
ValidateIssuerSigningKey = true,
IssuerSigningKey = signingKey,
ValidateIssuer = true,
ValidIssuer = audienceConfig["Issuer"],//发行人
ValidateAudience = true,
ValidAudience = audienceConfig["Audience"],//订阅人
ValidateLifetime = true,
RequireExpirationTime = true,
}; //主要部分
services.AddAuthentication("Bearer")
.AddJwtBearer(option =>
{
option.TokenValidationParameters = tokenValidationParameters;
}); #endregion
在configure 中配置,启用jwt官方中间件
//如果你想使用官方认证,必须在上边ConfigureService 中,配置JWT的认证服务 (.AddAuthentication 和 .AddJwtBearer 二者缺一不可)
app.UseAuthentication();
4、例子
在配置完成之后服务端需要提供一个GetToken(获取生成的jwt)的方法给前端,在需要使用认证的接口加上特性标签表示启用检测jwt是否有用
例(老方法,之后有空了补充新的生成jwt方法,加上refreshToken,避免token过期问题):
[Route("api/Blog")]
[Authorize]
public class BlogController : Controller
{
// GET: api/Blog/5
[HttpGet("GetToken")]
[AllowAnonymous]
public string GetToken()
{
TokenModelJwt tokenModel = new TokenModelJwt
{
Role="Admin",
Uid=1,
Work=""
};
return JwtHelper.IssueJwt(tokenModel); ;
}
}
/// <summary>
/// 颁发token
/// </summary>
/// <param name="tokenModel"></param>
/// <returns></returns>
public static string IssueJwt(TokenModelJwt tokenModel)
{
// 自己封装的 appsettign.json 操作类,看下文
string iss = Appsettings.app(new string[] { "Audience", "Issuer" }); //iss: 签发人
string aud = Appsettings.app(new string[] { "Audience", "Audience" });//aud: 受众
string secret = Appsettings.app(new string[] { "Audience", "Secret" }); var claims = new List<Claim>
{
new Claim(JwtRegisteredClaimNames.Jti,tokenModel.Uid.ToString()),//jti: 编号
new Claim(JwtRegisteredClaimNames.Iat,$"{new DateTimeOffset(DateTime.Now).ToUnixTimeMilliseconds()}"),//Iat 签发时间
//new Claim(JwtRegisteredClaimNames.Nbf,$"{new DateTimeOffset(DateTime.Now).ToUnixTimeMilliseconds()}"),//nbf: 生效时间
new Claim(JwtRegisteredClaimNames.Exp,$"{new DateTimeOffset(DateTime.Now.AddSeconds(1000)).ToUnixTimeMilliseconds()}"),//exp: 过期时间
//这个就是过期时间,目前是过期1000秒,可自定义,注意JWT有自己的缓冲过期时间
new Claim(JwtRegisteredClaimNames.Iss,iss),
new Claim(JwtRegisteredClaimNames.Aud,aud)
};
//// 可以将一个用户的多个角色全部赋予;
claims.AddRange(tokenModel.Role.Split(',').Select(e=>new Claim(ClaimTypes.Role,e)));
//秘钥 (SymmetricSecurityKey 对安全性的要求,密钥的长度太短会报出异常) var key=new SymmetricSecurityKey(Encoding.UTF8.GetBytes(secret));
var creds=new SigningCredentials(key,SecurityAlgorithms.HmacSha256); var jwt = new JwtSecurityToken(
issuer: iss,
audience: aud,
claims: claims,
expires:DateTime.Now.AddHours(1),
signingCredentials: creds); var jwtHandler = new JwtSecurityTokenHandler();
var encodedJwt = jwtHandler.WriteToken(jwt); return encodedJwt;
}
补充Appsetings类(有空了修改更加简介的方式),使用记得去Startup里面注入,注入方法:services.AddSingleton(new Appsettings(Env.ContentRootPath));
public class Appsettings
{
static IConfiguration Configuration { get; set; }
static string contentPath { get; set; } public Appsettings(string contentPath)
{
//如果你把配置文件 是 根据环境变量来分开了,可以这样写
string Path = $"appsettings.{Environment.GetEnvironmentVariable("ASPNETCORE_ENVIRONMENT")}.json"; //string Path = "appsettings.json"; Configuration = new ConfigurationBuilder()
.SetBasePath(contentPath)
.Add(new JsonConfigurationSource {Path = Path, Optional = false, ReloadOnChange = true})
.Build();
} public static string app(params string[] sections)
{
try
{
if (sections.Any())
{
return Configuration[string.Join(":", sections)];
}
}
catch (Exception) { }
return "";
}
}
最后,以上代码大部分使用的是“老张的哲学”Blog.Core项目的代码,个人学习使用,之后会修改掉,如有侵权请联系删除。
最新文章
- xdebug所有相关方法函数详解(中文翻译版)
- 获取设备的mac地址和IP地址(android6.0以上专用)
- 安装windows后重新修复grub2的引导
- Android LayoutParams简介
- Copying Rowsets
- 【BZOJ 2301】[HAOI2011]Problem b
- ajax 简单操作
- linux高级技巧:rsync同步(一个)
- Java中使用poi导入、导出Excel
- WinForm事件中的Object sender和EventArgs e参数
- 从零部署Spring boot项目到云服务器(正式部署)
- Python入门指南(超详细)
- MapReduce输出文件名更改
- 【最短路】道路重建 @upcexam5797
- ECMAScript 6 学习总结
- PHP的curl查看header信息的功能(包括查看返回header和请求header)
- 椭圆曲线签名算法的v的定义
- (转)Introduction to Gradient Descent Algorithm (along with variants) in Machine Learning
- JVM调优的总结
- codeforces 741D Arpa’s letter-marked tree and Mehrdad’s Dokhtar-kosh paths(启发式合并)
热门文章
- .net core ioc
- python语法基础-网络编程-TCP协议和UDP协议
- 把Java代码转成c#可用的dll
- asp.net 管道处理模式
- android高仿抖音、点餐界面、天气项目、自定义view指示、爬取美女图片等源码
- 关于Angular2与蚂蚁的NG-ZOORO一同开发时[disabled]=";true";动态绑定失效的解决方法
- Web前端性能
- 【Linux_Shell 脚本编程学习笔记二、打印菜单】
- Android开发之《ffmpeg解码mjpeg视频流》
- 为何印度打车软件Ola,也难逃“资本合并”命运?