Node.js——JWT和session | 青训营笔记

148 阅读9分钟

这是我参与「第五届青训营 」伴学笔记创作活动的第 8 天

Session 认证机制

来源

什么是HTTP协议的无状态性 ?

为了知道Seesion为何诞生,首先我们需要来了解一下HTTP协议的无状态性

HTTP协议的无状态性,指的是客户端的每次HTTP请求都是独立的,连续多个请求之间没有直接的关系,服务器不会主动保留每次HTTP请求的状态。所以我们每次请求都不会保留记录,因此http诞生了一个叫cookie的东西。

什么是Cookie ?

Cookie是存储在用户浏览器中的一段不超过4 KB的字符串。它由一个名称(Name)、一个值(Value) 和其它几个用

于控制Cookie有效期、安全性、使用范围的可选属性组成。

不同域名下的Cookie各自独立,每当客户端发起请求时,会自动把当前域名下所有未过期的Cookie 一同发送到服务器。

Cookie的几大特性:

①自动发送

②域名独立

③过期时限

④4KB限制

Cookie在身份认证中的作用

客户端第一次请求服务器的时候,服务器通过响应头的形式,向客户端发送一个身份认证的 Cookie,客户端会自动

将Cookie保存在浏览器中。

随后,当客户端浏览器每次请求服务器的时候,浏览器会自动将身份认证相关的Cookie,通过请求头的形式发送给

服务器,服务器即可验明客户端的身份。

现在我们知道了cookie在前后端交互的意义了,但是cookie其实十分不安全,由于cookie容易被获取,所以我们一下重要信息显然不能简单的用cookie来存储。这时我们就需要cookie + 身份验证的方法诞生了——session。

Session的工作原理

在登陆注册时,客户端会先将密码和账号发给服务端server,sever会验证密码和账号,并返回一个session_id给client,并且server也会把这个session_id存在数据库中,当client再次发送请求时,会携带该域名下的所有cookie给server,如果其中有用户的信息的session_id,server会拿取这个session_id到数据库查找对应的用户名和密码,如果与client的用户名密码一致,server才能验证成功身份返回对应的内容。

注意:session_id一般存储在cookie中,但是由于JS不让访问这种cookie,因此对于跨域的请求就无法完成了。

在Express中的session认证

1.安装express-session中间件

npm i express-session

2.配置express-session中间件

express-session 中间件安装成功后,需要通过 app.use() 来注册 session 中间件,示例代码如下:

// 导入 express 模块
const express = require('express')
// 创建 express 的服务器实例
const app = express()

// TODO_01:请配置 Session 中间件
const session = require('express-session')
app.use(
  session({
    secret: 'random_keyborad', // 加密字符串,任意写一个字符串即可
    resave: false,   // 固定写法
    saveUninitialized: true, // 固定写法
  })
)

// 托管静态页面
app.use(express.static('./pages'))
// 解析 POST 提交过来的表单数据
app.use(express.urlencoded({ extended: false }))

3.向session中存储数据

当 express-session 中间件配置成功后,即可通过 req.session来访问和使用 session 对象,从而存储用户的关键信息:

// 登录的 API 接口
app.post('/api/login', (req, res) => {
  // 判断用户提交的登录信息是否正确
  if (req.body.username !== 'admin' || req.body.password !== '000000') {
    return res.send({ status: 1, msg: '登录失败' })
  }

  // TODO_02:请将登录成功后的用户信息,保存到 Session 中
  // 注意:只有成功配置了 express-session 这个中间件之后,才能够通过 req 点出来 session 这个属性
  req.session.user = req.body // 用户的信息
  req.session.islogin = true // 用户的登录状态

  res.send({ status: 0, msg: '登录成功' })
})

4.向session获取数据

可以直接从 req.session对象上获取之前存储的数据,示例代码如下:

// 获取用户姓名的接口
app.get('/api/username', (req, res) => {
  // TODO_03:请从 Session 中获取用户的名称,响应给客户端
  if (!req.session.islogin) {
    return res.send({ status: 1, msg: 'fail' })
  }
  res.send({
    status: 0,
    msg: 'success',
    username: req.session.user.username,
  })
})

5.清空session

调用 req.session.destroy() 函数,即可清空服务器保存的 session 信息。

// 退出登录的接口
app.post('/api/logout', (req, res) => {
  // TODO_04:清空 Session 信息
  req.session.destroy()
  res.send({
    status: 0,
    msg: '退出登录成功',
  })
})

JWT 认证机制

来源

Session 认证机制需要配合 Cookie 才能实现。由于 Cookie 默认不支持跨域访问,所以,当涉及到前端跨域请求后端接口的时候,需要做很多额外的配置,才能实现跨域 Session 认证。

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

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

JWT的工作原理

首先client会发送用户名和密码给server,server会根据自己服务器内的secret密钥 + client的用户名和密码,通过哈希加密算法,生成一段JWT字符串,并且把这段字符串放回给client。此时这段JWT字符串server是不需要保存在数据库或这服务端的。那server是如何验证的呢?在下一次client提交用户名密码时会携带上之前生成的JWT字符串,server只需要在次通过哈希加密算法,来生成一段新的JWT字符串,在将这段新的字符串与client发回来的JWT字符串进行比对,如果一致的话,则验证成功。

这个哈希加密算法,在有secret密钥和用户名信息后,可以在很短时间内算出来JWT字符串,而如果只知道JWT字符串和用户名信息,则很难在有限的时间内算出来secret密钥,基本无法推出来。

所以我们会给JWT字符串定义一个限期,保证足够的安全性。

JWT的组成部分

JWT 通常由三部分组成,分别是 Header(头部)、Payload(有效荷载)、Signature(签名)。

三者之间使用英文的“.”分隔,格式如下:

例子:

JWT 的三个组成部分,从前到后分别是 Header、Payload、Signature。

其中:

Payload部分才是真正的用户信息,它是用户信息经过加密之后生成的字符串。

Header 和 Signature 是安全性相关的部分,只是为了保证 Token 的安全性。

JWT的使用方式

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

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

在Express中的JWT

1.安装JWT包

npm i jsonwebtoken express-jwt

jsonwebtoken用于生成 JWT 字符串

express-jwt用于将 JWT 字符串解析还原成 JSON 对象

2.导入JWT包

使用 require() 函数,分别导入 JWT 相关的两个包:

// 导入 express 模块
const express = require('express')
// 创建 express 的服务器实例
const app = express()

// TODO_01:安装并导入 JWT 相关的两个包,分别是 jsonwebtoken 和 express-jwt
const jwt = require('jsonwebtoken')
const expressJWT = require('express-jwt')

// 允许跨域资源共享
const cors = require('cors')
app.use(cors())

// 解析 post 表单数据的中间件
const bodyParser = require('body-parser')
app.use(bodyParser.urlencoded({ extended: false }))

3.定义secret密钥

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

  1. 当生成 JWT 字符串的时候,需要使用 secret 密钥对用户的信息进行加密,最终得到加密好的 JWT 字符串
  2. 当把 JWT 字符串解析还原成 JSON 对象的时候,需要使用 secret 密钥进行解密
// TODO_02:定义 secret 密钥,建议将密钥命名为 secretKey
const secretKey = 'random_keyboard'

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

// 登录接口
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, // 要发送给客户端的 JWT字符串
  })
})

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

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

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

// TODO_04:注册将 JWT 字符串解析还原成 JSON 对象的中间件
// 注意:只要配置成功了 express-jwt 这个中间件,就可以把解析出来的用户信息,挂载到 req.user 属性上
app.use(expressJWT({ secret: secretKey }).unless({ path: [/^/api//] }))

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

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

// 这是一个有权限的 API 接口
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 的错误中间件,捕获这个错误并进行相关的处理,示例代码如下:

// 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: '未知的错误',
  })
})