写点什么

浅析 + 在 Node 中实现 JWT 鉴权机制!

作者:CoderBin
  • 2022 年 10 月 11 日
    广东
  • 本文字数:5246 字

    阅读完需:约 17 分钟

浅析+在Node中实现JWT鉴权机制!

前言

大家好,我是 CoderBin, 由于最近的项目用到了 JWT 鉴权机制,所以本次想跟大家分享关于后端 JWT 鉴权的相关原理和如何在 Node 中去使用,希望对大家有所帮助,谢谢。


如果文中有不对、疑惑的地方,欢迎在评论区留言指正🌻


高频面试总结

【1】75道关于CSS的高频面试题总结,请注意查收!🔥

【2】关于Vue的一些高频面试题总结

面试官系列文章

【1】面试官:你说说 js 中实现继承有哪几种方法?

【2】面试官:说说你对事件循环的理解

一、为什么使用 JWT

一种技术的出现,就是弥补另一种技术的的缺陷。在 JWT 出现之前,Session 认证机制需要配合 Cookie 才能实现。由于 Cookie 默认不支持跨域访问,所以,当涉及到前端跨域请求后端接口的时候,需要做很多额外的配置,才能实现跨域 Session 认证。


注意:


  • 当前端请求后端接口不存在跨域问题的时候,推荐使用 Session 身份认证机制。

  • 当前端需要跨域请求后端接口的时候,不推荐使用 Session 身份认证机制,推荐使用 JWT 认证机制

二、JWT 是什么

JWT(英文全称:JSON Web Token)是目前最流行的跨域认证解决方案。本质就是一个字符串书写规范,如下图,作用是用来在用户和服务器之间传递安全可靠的信息



在目前前后端分离的开发过程中,使用token鉴权机制用于身份验证是最常见的方案,流程如下:


  • 服务器当验证用户账号和密码正确的时候,给用户颁发一个令牌,这个令牌作为后续用户访问一些接口的凭证

  • 后续访问会根据这个令牌判断用户是否有权限进行访问

三、JWT 工作原理


总结:用户的信息通过 Token 字符串的形式,保存在客户端浏览器中。服务器通过还原 Token 字符串的形式来认证用户的身份。

四、token 的组成部分

Token,分成了三部分,头部(Header)、载荷(Payload)、签名(Signature),并以.进行拼接。其中头部和载荷都是以JSON格式存放数据,只是进行了编码。格式如下:


Header.Payload.Signature
复制代码


下面是 JWT 字符串的示例:


Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VybmFtZSI6ImFkbWluIiwiaWF0IjoxNjQ0ODI3NzI2LCJleHAiOjE2NDQ4Mjc3NTZ9.gdZKg9LkPiQZIgNAZ1Mn14GQd9kZZua-_unwHQoRsKE
复制代码


注意:Bearer 是手动添加的头部信息,必须携带此信息才能解析 token !

五、token 的三个部分的含义

1. header

每个 JWT 都会带有头部信息,这里主要声明使用的算法。声明算法的字段名为alg,同时还有一个typ的字段,默认JWT即可。以下示例中算法为 HS256:


{ "alg": "HS256", "typ": "JWT" }
复制代码


因为 JWT 是字符串,所以我们还需要对以上内容进行 Base64 编码,编码后字符串如下:


eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9
复制代码

2. payload

载荷即消息体,这里会存放实际的内容,也就是Token的数据声明,例如用户的idname,默认情况下也会携带令牌的签发时间iat,通过还可以设置过期时间,如下:


{    "sub": "1234567890",    "name": "CoderBin",    "iat": 1516239022}
复制代码


同样进行 Base64 编码后,字符串如下:


eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ
复制代码

3. Signature

签名是对头部和载荷内容进行签名,一般情况,设置一个secretKey,对前两个的结果进行HMACSHA25算法,公式如下:


Signature = HMACSHA256(base64Url(header)+.+base64Url(payload),secretKey)
复制代码


一旦前面两部分数据被篡改,只要服务器加密用的密钥没有泄露,得到的签名肯定和之前的签名不一致

六、JWT 使用方式

客户端收到服务器返回的 JWT 之后,通常会将它储存在 localStoragesessionStorage 中。


此后,客户端每次与服务器通信,都要带上这个 JWT 的字符串,从而进行身份认证。推荐的做法是把 JWT 放在 HTTP 请求头的 Authorization 字段中,格式如下:


Authorization: Bearer <token>
复制代码

七、JWT 实现

Token 的使用分成了两部分:


  • 生成 token:登录成功的时候,颁发 token

  • 验证 token:访问某些资源或者接口时,验证 token


接下来就在 node+express 环境下带大家实现 jwt 鉴权,最后有完整代码加注释,可以直接看最后的代码

1. 安装 JWT 相关的包

运行如下命令,安装如下两个 JWT 相关的包:


npm i jsonwebtoken express-jwt
复制代码


其中:


  • jsonwebtoken 用于生成 JWT 字符串

  • express-jwt 用于验证 token,将 JWT 字符串解析还原成 JSON 对象

2. 导入 JWT 相关的包

app.js


// 导入用于生成 JWT 字符串的包const jwt = require('jsonwebtoken')
// 导入用户将客户端发送过来的 JWT 字符串,解析还原成 JSON 对象的包const expressJWT = require('express-jwt')
复制代码

3. 定义 secret 密钥 *

为了保证 JWT 字符串的安全性,防止 JWT 字符串在网络传输过程中被别人破解,我们需要专门定义一个用于加密解密的 secret 密钥:


  1. 当生成 JWT 字符串的时候,需要使用 secret 密钥对用户的信息进行加密,最终得到加密好的 JWT 字符串

  2. 当把 JWT 字符串解析还原成 JSON 对象的时候,需要使用 secret 密钥进行解密


// 这个 secretKey 的是可以是任意的字符串const secretKey = 'CoderBin ^_^'
复制代码

4. 在登录成功后生成 JWT 字符串 *

调用 jsonwebtoken 包提供的 sign() 方法,将用户的信息加密成 JWT 字符串,响应给客户端:


  • 参数 1:用户的信息对象

  • 参数 2:解密的秘钥

  • 参数 3:配置对象,可以配置 token 的有效期


注意:千万不要把密码加密到 token 字符串中!


// 登录接口app.post('/api/login', function (req, res) {  // 将 req.body 请求体中的数据,转存为 userinfo 常量  const userinfo = req.body  // 省略登录失败情况下的代码... 
// 登录成功 // 在登录成功之后,调用 jwt.sign() 方法生成 JWT 字符串。并通过 token 属性发送给客户端 const tokenStr = jwt.sign( { username: userinfo.username }, secretKey, { expiresIn: '30s' } ) // 向客户端响应成功的消息 res.send({ status: 200, message: '登录成功!', token: tokenStr // 要发送给客户端的 token 字符串 })})
复制代码

5. 将 JWT 字符串还原为 JSON 对象 *

客户端每次在访问那些有权限接口的时候,都需要主动通过请求头中的 Authorization 字段,将 Token 字符串发送到服务器进行身份认证。


此时,服务器可以通过 express-jwt 这个中间件,自动将客户端发送过来的 Token 解析还原成 JSON 对象:


  • express.JWT({ secret: secretKey, algorithms: ['HS256'] }) 就是用来解析 Token 的中间件

  • express-jwt 模块,现在默认为 6 版本以上,必须加上: algorithms: ['HS256']


注意:只要配置成功了 express-jwt 这个中间件,就会自动把解析出来的用户信息,挂载到 req.user 属性上


// 1. 使用 app.use() 来注册中间件app.use(expressJWT({   secret: secretKey,   algorithms: ['HS256'] }).unless({ path: [/^\/api\//] }))
复制代码


注意


  • secret 必须和 sign 时候保持一致

  • 可以通过 unless 配置接口白名单,也就是哪些 URL 可以不用经过校验,像登陆/注册都可以不用校验

  • 校验的中间件需要放在需要校验的路由前面,无法对前面的 URL 进行校验

6. 使用 req.user 获取用户信息

当 express-jwt 这个中间件配置成功之后,即可在那些有权限的接口中,使用 req.user 对象,来访问从 JWT 字符串中解析出来的用户信息了,示例代码如下:


// 这是一个有权限的 API 接口,必须在 Header 中携带 Authorization 字段,值为 token,才允许访问app.get('/admin/getinfo', function (req, res) {  // TODO_05:使用 req.user 获取用户信息,并使用 data 属性将用户信息发送给客户端  console.log(req.user);  res.send({    status: 200,    message: '获取用户信息成功!',    data: req.user // 要发送给客户端的用户信息  })})
复制代码

7. 捕获解析 JWT 失败后产生的错误

当使用 express-jwt 解析 Token 字符串时,如果客户端发送过来的 Token 字符串过期或不合法,会产生一个解析失败的错误,影响项目的正常运行。我们可以通过 Express 的错误中间件,捕获这个错误并进行相关的处理,示例代码如下:


app.use((err, req, res, next) => {  // 这次错误是由 token 解析失败导致的  if (err.name === 'UnauthorizedError') {    return res.send({      status: 401,      message: '无效的token'    })  }  res.send({    status: 500,    message: '未知的错误'  })})
复制代码

8. 完整代码

app.js


// 导入 express 模块const express = require('express')// 创建 express 的服务器实例const app = express()
// TODO_01:安装并导入 JWT 相关的两个包,分别是 jsonwebtoken 和 express-jwtconst jwt = require('jsonwebtoken')const expressJWT = require('express-jwt')

// 允许跨域资源共享const cors = require('cors')app.use(cors())
// 解析 post 表单数据的中间件const bodyParser = require('body-parser')// 这里用内置的中间件也行: app.use(express.urlencoded({ extended: false }))app.use(bodyParser.urlencoded({ extended: false }))
// TODO_02:定义 secret 密钥,建议将密钥命名为 secretKey// 这个 secretKey 的是可以是任意的字符串const secretKey = 'smiling ^_^'
// TODO_04:注册将 JWT 字符串解析还原成 JSON 对象的中间件// 1. 使用 app.use() 来注册中间件// 2. express.JWT({ secret: secretKey, algorithms: ['HS256'] }) 就是用来解析 Token 的中间件// 2.1 express-jwt 模块,现在默认为 6版本以上,必须加上: algorithms: ['HS256']// 3. .unless({ path: [/^\/api\//] }) 用来指定哪些接口不需要访问权限// 4. 注意:只要配置成功了 express-jwt 这个中间件,就会自动把解析出来的用户信息,挂载到 req.user 属性上app.use(expressJWT({ secret: secretKey, algorithms: ['HS256'] }).unless({ path: [/^\/api\//] }))
// 登录接口app.post('/api/login', function (req, res) { // 将 req.body 请求体中的数据,转存为 userinfo 常量 const userinfo = req.body // 登录失败 if (userinfo.username !== 'admin' || userinfo.password !== '000000') { return res.send({ status: 400, message: '登录失败!' }) } // 登录成功 // TODO_03:在登录成功之后,调用 jwt.sign() 方法生成 JWT 字符串。并通过 token 属性发送给客户端 // 参数 1:用户的信息对象 // 参数 2:解密的秘钥 // 参数 3:配置对象,可以配置 token 的有效期 // 记住:千万不要把密码加密到 token 字符串中! const tokenStr = jwt.sign({ username: userinfo.username }, secretKey, { expiresIn: '30s' }) res.send({ status: 200, message: '登录成功!', token: tokenStr // 要发送给客户端的 token 字符串 })})
// 这是一个有权限的 API 接口,必须在 Header 中携带 Authorization 字段,值为 token,才允许访问app.get('/admin/getinfo', function (req, res) { // TODO_05:使用 req.user 获取用户信息,并使用 data 属性将用户信息发送给客户端 console.log(req.user); res.send({ status: 200, message: '获取用户信息成功!', data: req.user // 要发送给客户端的用户信息 })})
// TODO_06:使用全局错误处理中间件,捕获解析 JWT 失败后产生的错误app.use((err, req, res, next) => { // 这次错误是由 token 解析失败导致的 if (err.name === 'UnauthorizedError') { return res.send({ status: 401, message: '无效的token' }) } res.send({ status: 500, message: '未知的错误' })})
// 调用 app.listen 方法,指定端口号并启动web服务器app.listen(8888, function () { console.log('Express server running at http://127.0.0.1:8888')})
复制代码

八. 测试结果

1 测试登录接口

借助 postman 工具测试接口


2. 测试登录需要权限的接口-失败

3. 测试登录需要权限的接口-成功

九、最后总结

JWT 鉴权机制有许多优点:


  • json 具有通用性,所以可以跨语言

  • 组成简单,字节占用小,便于传输

  • 服务端无需保存会话信息,很容易进行水平扩展

  • 一处生成,多处使用,可以在分布式系统中,解决单点登录问题

  • 可防护 CSRF 攻击


当然,不可避免的也有一些缺点:


  • payload 部分仅仅是进行简单编码,所以只能用于存储逻辑必需的非敏感信息

  • 需要保护好加密密钥,一旦泄露后果不堪设想

  • 为避免 token 被劫持,最好使用 https 协议


本次的浅析 JWT 鉴权机制就讲到这里,希望对大家有所帮助,谢谢!

往期推荐 💐 🌸 🌹 🌻 🌺 🍁

高阅读好文


【1】关于Vue的一些高频面试题总结


【2】75道关于CSS的高频面试题总结,请注意查收!🔥


【3】Vue内置指令大全


【4】面试官:你说说 js 中实现继承有哪几种方法?


【5】一篇文章带你搞懂 this 的四个绑定规则 ✍


----- 🌻 查看全部 🍁 -----




每文一句:学者如登山焉,动而益高,如寤寐焉,久而益足——徐干


本次的分享就到这里,如果本章内容对你有所帮助的话欢迎点赞+收藏。文章有不对的地方欢迎指出,有任何疑问都可以在评论区留言。希望大家都能够有所收获,大家一起探讨、进步!

发布于: 刚刚阅读数: 6
用户头像

CoderBin

关注

始于前端,终于..... 2020.10.14 加入

普通人只考虑他们将如何度过时间,而有智慧的人则试图利用时间 — CoderBin

评论

发布
暂无评论
浅析+在Node中实现JWT鉴权机制!_前端_CoderBin_InfoQ写作社区