学习笔记:初学JWT,并在Node中使用

854 阅读7分钟

1.JWT是什么

JSON Web Token(缩写 JWT)是一种跨域认证解决方案。服务器认证以后,生成一个字符串,发回给用户,为了防止用户篡改数据,服务器在生成这个字符串的时候,会加上签名。以后,用户与服务端通信的时候,都要带上这个字符串。服务器完全只靠这个字符串认定用户身份。字符串的形式如下这样:eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c

这个字符串我们可以称之为JWT。JWT字符串可以在官网上jwt.io/去解析出来。解析出来后,发现有三个部分。仔细看JWT字符串,有两个点(.)把字符串分隔开了,其实就是和解析后的结构一一对应。

这三个部分就是JWT的数据结构。分别是Header(头部),Payload(负载),Signature(签名)。

1.Header(头部)

Header 部分是一个 JSON 对象,描述 JWT 的元数据。

{
  "alg": "HS256",
  "typ": "JWT"
}

alg属性表示签名的算法(algorithm),默认是 HMAC SHA256(写成 HS256)。

typ属性表示这个令牌(token)的类型(type),JWT 令牌统一写为JWT。

上面的 JSON 对象会使用 Base64URL 算法转成字符串。

2.Payload(负载)

Payload 部分也是一个 JSON 对象,用来存放实际需要传递的数据。注意,JWT 默认是不加密的,任何人都可以读到,密码等敏感信息不要放进来。

这个数据可以是JWT 本身自己有的字段,也可以自己的自定义数据,如例子中的name字段。

iss (issuer):签发人

exp (expiration time):过期时间

sub (subject):主题

aud (audience):受众

nbf (Not Before):生效时间

iat (Issued At):签发时间

jti (JWT ID):编号

{
  "sub": "1234567890",
  "name": "John Doe",
  "iat": 1516239022
}

这个 JSON 对象也要使用 Base64URL 算法转成字符串。

3.Signature(签名)

Signature 部分是对前两部分的签名,防止数据篡改。 首先,需要指定一个密钥(secret)。这个密钥只有服务器才知道,不能泄露给用户。然后,使用 Header 里面指定的签名算法(默认是 HMAC SHA256),按照下面的公式产生签名。 

HMACSHA256( base64UrlEncode(header) + "." + base64UrlEncode(payload), secret) 

算出签名以后,把 Header、Payload、Signature 三个部分拼成一个字符串,每个部分之间用"点"(.)分隔,就可以返回给用户。

2.JWT的特点

  1. JWT 默认是不加密,但也是可以加密的。生成原始 Token 以后,可以用密钥再加密一次。

  2. JWT 不加密的情况下,不能将秘密数据写入 JWT。

  3. JWT 不仅可以用于认证,也可以用于交换信息。有效使用 JWT,可以降低服务器查询数据库的次数。

  4. JWT 的最大缺点是,由于服务器不保存 session 状态,因此无法在使用过程中废止某个 token,或者更改 token 的权限。也就是说,一旦 JWT 签发了,在到期之前就会始终有效,除非服务器有额外的逻辑控制。

  5. JWT 本身包含了认证信息,一旦泄露,任何人都可以获得该令牌的所有权限。为了减少盗用,JWT 的有效期应该设置得比较短。对于一些比较重要的权限,使用时应该再次对用户进行认证。

  6. 为了减少盗用,JWT 不应该使用 HTTP 协议明码传输,要使用 HTTPS 协议传输。

3.解决了什么痛点

常见的用户认证方式可能是这样的:

  1. 用户向服务器发送用户名和密码。

  2. 服务器验证通过后,在当前对话(session)里面保存相关数据,比如用户角色、登录时间等等。

  3. 服务器向用户返回一个 session_id,写入用户的 Cookie。

  4. 用户随后的每一次请求,都会通过 Cookie,将 session_id 传回服务器。

  5. 服务器收到 session_id,找到前期保存的数据,由此得知用户的身份。

这种方式的问题在于,扩展性不好。单机当然没有问题,如果是服务器集群,或者是跨域的服务导向架构,就要求 session 数据共享,每台服务器都能够读取 session 。

举例来说,A 网站和 B 网站是同一家公司的关联服务。现在要求,用户只要在其中一个网站登录,再访问另一个网站就会自动登录,请问怎么实现? 

一种解决方案是 session 数据持久化,写入数据库或别的持久层。各种服务收到请求后,都向持久层请求数据。这种方案的优点是架构清晰,缺点是工程量比较大。另外,持久层万一挂了,就会单点失败。

 另一种方案是服务器索性不保存 session 数据了,所有数据都保存在客户端,每次请求都发回服务器。JWT 就是这种方案的一个代表。 服务器就不保存任何 session 数据了,也就是说,服务器变成无状态了,从而比较容易实现扩展。

4.Base64URL

Header 和 Payload 串型化的算法是 Base64URL。这个算法跟 Base64 算法基本类似,但有一些小的不同。

JWT 作为一个令牌(token),有些场合可能会放到 URL(比如api.example.com/?token=xxx)。Base64 有三个字符+、/和=,在 URL 里面有特殊含义,所以要被替换掉:=被省略、+替换成-,/替换成_ 。这就是 Base64URL 算法。

5.JWT 的使用方式

客户端收到服务器返回的 JWT,可以储存在 Cookie 里面,也可以储存在 localStorage。 此后,客户端每次与服务器通信,都要带上这个 JWT。你可以把它放在 Cookie 里面自动发送,但是这样不能跨域,所以更好的做法是放在 HTTP 请求的头信息Authorization字段里面。

6.在node项目中使用

单单看概念,可能只是知道一个流程,我们还要根据这个流程,在实际项目中去应用,加深理解。首先下载jsonwebtoken这个依赖,当然你也可以选择其他的库。库的具体使用方法可以看官方例子github.com/auth0/node-…

示例代码均是简化版(毕竟涉及到公司项目)

1.function sign(payload,secretOrPrivateKey,options,callback)

签名,sign方法用到了有4个参数。

payload是返回的数据。

secretOrPrivateKey,这个就是密钥secret。

options就是对JWT的配置。

callback就是回调方法。

例子中,payload的信息里面包含用户名user_name,用户类型user_type。secretOrPrivateKey,自己根据需要定义。记得签名和验签的时候用同一个密钥就行。options,配置了一天后过期。callback,失败返回err信息,成功返回encoded,也就是JWT字符串。

const jwt = require('jsonwebtoken');

const login = async ({ userName, password }) => {
  // 具体的登录逻辑,看个人项目需求,略
  //是否使用异步,主要看上层调用。我上层是异步的,所以返回一个promise
  return new Promise((resolve, reject) =>
    jwt.sign(
      { user_name, user_type },
      secret,
      { expiresIn: '1 days' },
      (err, encoded) => {
        if (err) {
          reject(err);
        }
        resolve({ userToken: encoded });
      }
    )
  );
};

好了,客户端已经拿到这个JWT字符串了,我是放在了localStorage。

localStorage.setItem(storage.token, token)

2.function decode(token)

上面说到了,JWT有个特点就是可以交换信息,假设我需要根据用户类型,去做相应的权限控制,如果没有JWT,我们可能还得再请求后台,获取当前用户的类型是什么。但是我们把用户类型放在了JWT里面了,所以我们直接解析出来去用就好了。

const token = localStorage.getItem('userToken'); // 从localStorage拿出JWT字符串
const userInfo = jwt.decode(token); //解析出来,拿到payload数据
const userType = userInfo.user_type; // 找到用户类型字段

3.function verify(token,secretOrPublicKey,options,callback)

每次用户请求都要带上这个token,服务端要验证这个token 是否合法。我是用express框架,把token验证做成一个中间件去校验。

token参数,就是JWT字符串,要从headers里面拿,我是放在token字段,你们可以自己定义。

secret参数,要和签名的secret一致。

options参数,没有用到,略。

callback参数,回调,失败返回错误信息,成功就next继续。

const jwt = require('jsonwebtoken');

const token = ({ req, res, next }) => {
  const token = req.headers.token;   
  jwt.verify(token, secret, (err, decoded) => {
    if (err) {
      logger.error(err);
      res.status(400).json({ message: 'Token无效' });
      return;
    }
    req.userInfo = decoded;
    next();
  });
};

好了,目前主要用到的方法就这么多,总结一下,结合JWT原理,我在项目中的使用流程是这样的,用户登录成功后,签名返回token,客户端保存token,客户端每次请求,都带上token,在express中间件验签token是否有效。

大家如果有更好的流程和使用方式,也可以与我分享。

参考资料:

JSON Web Token 入门教程