5、JWT 认证机制
- 了解 Session 认证的局限性
Session 认证机制需要配合 Cookie 才能实现。由于 Cookie 默认不支持跨域访问,所以,当涉及前端跨域请求后端接口的时候,需要做很多额外的配置
,才能实现跨域 Session 认证。
注意:
1、当前端请求后端接口不存在跨域问题
的时候,推荐使用Session
身份认证机制。
2、当前端需要跨域请求后端接口的时候,不推荐使用 Session 身份认证机制,推荐使用 JWT 认证机制。
- 什么是 JWT
JWT(英文全称:JSON Web Token)是目前最流行
的跨域认证解决方案
。 - JWT 的工作原理
用户的信息通过 Token 字符串的形式,保存在客户端浏览器中。服务器通过还原 Token 字符串的形式来认证用户的身份。
- JWT 的组成部分
JWT 通常由三部分组成,分别是 Header(头部)、Payload(有效荷载)、Signature(签名)。 三者之间使用英文的“.”分隔,格式如下:
Header.Payload.Signature
- JWT 的示例
下面是 JWT 字符串的示例:
JWT 是一个很长的字符串,中间用英文的点(.)分隔成三个部分。
注意:JWT内部是没有换行的
,这里只是为了便于展示,将它写成了 3 行。
- JWT 的三个部分各自代表的含义
JWT 的三个组成部分,从前到后分别是 Header、Payload、Signature。
其中:
Payload
部分才是真正的用户信息
,它是用户信息经过加密之后生成的字符串。- Header 和 Signature 是
安全性相关
的部分,只是为了保证 Token 的安全性。
JWT 的使用方式
客户端收到服务器返回的 JWT 之后,通常会将它储存在 localStorage 或 sessionStorage 中。
此后,客户端每次与服务器通信,都要带上这个 JWT。推荐的做法是把JWT放在 HTTP请求头的Authorization字段 中,格式如下:
Authorization: Bearer <token>
6、在 Express 中使用 JWT
- 安装 JWT 相关的包
运行如下命令,安装如下两个 JWT 相关的包:
npm install jsonwebtoken express-jwt
其中:
- jsonwebtoken 用于生成 JWT 字符串
- express-jwt 用于将JWT 字符串解析还原成 JSON 对象
导入 JWT 相关的包
使用 require()
函数,分别导入 JWT 相关的两个包:
// TODO_01:安装并导入 JWT 相关的两个包,分别是 jsonwebtoken 和 express-jwt const jwt = require('jsonwebtoken') const expressJWT = require('express-jwt')
- 定义 secret 密钥
为了保证 JWT 字符串的安全性,防止 JWT 字符串在网络传输过程中被别人破解,我们需要专门定义一个用于加密
和解密
的 secret 密钥:
1、当生成 JWT 字符串的时候,需要使用 secret 密钥对用户的信息进行加密,最终得到加密好的 JWT 字符串。
2、当把 JWT 字符串解析还原成 JSON 对象的时候,需要使用 secret 密钥进行解密。
// TODO_02:定义 secret 密钥,建议将密钥命名为 secretKey const secretKey = "itpeiliboNo.1 ^_^";
在登录成功后生成 JWT 字符串
调用 jsonwebtoken
包提供的 sign()
方法,将用户的信息加密成 JWT 字符串,响应给客户端:
// TODO_03:在登录成功之后,调用 jwt.sign() 方法生成 JWT 字符串。并通过 token 属性发送给客户端 // 调用jwt,sign() 生成 JWT 字符串,三个参数分别是:用户信息对象、 加密密钥、配置对象(配置token失效时限) const tokenStr = jwt.sign({ usernam: userinfo.username }, secretKey, { expiresIn: "30s" });
- 注意:不要把密码加密到token字符串中。
- 注册将 JWT 字符串还原为 JSON 对象的中间件
客户端每次在访问那些有权限接口的时候,都需要主动通过请求头中的Authorization字段
,将 Token 字符串发送到服务器进行身份认证。
此时,服务器可以通过 express-jwt
这个中间件,自动将客户端发送过来的 Token 解析还原成 JSON 对象。
// TODO_04:注册将 JWT 字符串解析还原成 JSON 对象的中间件 // 使用app.use()来注册中间件 // express JWT({ secret: secretkey })就是用来解析 Token 的中间件 // .unless({ path: [/^\/api\//] }) 用来指定哪些接口不需要访问权限 // 注意:2020.7.7日jwt更新之后,安装的express-jwt模块会默认为6.0.0版本,更新后的jwt需要在配置中加入algorithms属性,即设置jwt的算法。一般HS256为配置algorithms的默认值 app.use(expressJWT({ secret: secretKey, algorithms: ['HS256'] }).unless({ path: [/^\/api\//] }));
使用 req.user 获取用户信息
当 express-jwt 这个中间件配置成功之后,即可在那些有权限的接口中,使用 req.user 对象
,来访问从 JWT 字符串 中解析出来的用户信息了,示例代码如下:
// TODO_05:使用 req.user 获取用户信息,并使用 data 属性将用户信息发送给客户端 console.log(req.user); res.send({ status: 200, message: "获取用户信息成功!", data: req.user, // 要发送给客户端的用户信息 });
捕获解析 JWT 失败后产生的错误
当使用 express-jwt 解析 Token 字符串时,如果客户端发送过来的 Token 字符串过期
或不合法
,会产生一个解析失败
的错误,影响项目的正常运行。我们可以通过 Express的错误中间件
,捕获这个错误并进行相关的处理,示例代码如下:
// TODO_06:使用全局错误处理中间件,捕获解析 JWT 失败后产生的错误 app.use((err, req, res, next) => { if (err.name === "UnauthorizedError") { return res.send({ status: 401, message: "无效的token!", }); } res.send({ status: 500, message: "未知错误!", }); });