来及阮一峰老师的介绍简要

# 来及阮一峰老师的介绍简要 (opens new window)

# 一、跨域认证的问题

互联网服务离不开用户认证。一般流程是下面这样。

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

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

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

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

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

TIP

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

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

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

另一种方案是服务器索性不保存 session 数据了，所有数据都保存在客户端，每次请求都发回服务器。JWT 就是这种方案的一个代表。

# 二、JWT 的原理

JWT 的原理是，服务器认证以后，生成一个 JSON 对象，发回给用户，就像下面这样。

{
  "姓名": "张三",
  "角色": "管理员",
  "到期时间": "2018年7月1日0点0分"
}

以后，用户与服务端通信的时候，都要发回这个 JSON 对象。服务器完全只靠这个对象认定用户身份。为了防止用户篡改数据，服务器在生成这个对象的时候，会加上签名（详见后文）。

服务器就不保存任何 session 数据了，也就是说，服务器变成无状态了，从而比较容易实现扩展

# 三、JWT 的数据结构

实际的 JWT 大概就像下面这样。

"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6MSwidXNlck5hbWUiOiJhZG1pbiIsImlhdCI6MTYxMzAyOTU5OCwiZXhwIjoxNjEzMTE1OTk4fQ.n-7lLPENQWmaqiKO-u7aXoNFGxl0PIgGQ52UVD92jn4"

TIP

它是一个很长的字符串，中间用点（.）分隔成三个部分。注意，JWT 内部是没有换行的，这里只是为了便于展示，将它写成了几行。

# JWT 的三个部分依次如下。


*  Header（头部）
*  Payload（负载）
*  Signature（签名）

写成一行，就是下面的样子。


Header.Payload.Signature

# 3.1Header

Header 部分是一个 JSON 对象，描述 JWT 的元数据，通常是下面的样子。


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

上面代码中，alg属性表示签名的算法（algorithm），默认是 HMAC SHA256（写成 HS256）；typ属性表示这个令牌（token）的类型（type），JWT 令牌统一写为JWT。

最后，将上面的 JSON 对象使用 Base64URL 算法（详见后文）转成字符串。

# 3.2 Payload

Payload 部分也是一个 JSON 对象，用来存放实际需要传递的数据。JWT 规定了7个官方字段，供选用。


iss (issuer)：签发人
exp (expiration time)：过期时间
sub (subject)：主题
aud (audience)：受众
nbf (Not Before)：生效时间
iat (Issued At)：签发时间
jti (JWT ID)：编号

除了官方字段，你还可以在这个部分定义私有字段，下面就是一个例子。


{
  "sub": "1234567890",
  "name": "John Doe",
  "admin": true
}

TIP

注意，JWT 默认是不加密的，任何人都可以读到，所以不要把秘密信息放在这个部分。这个 JSON 对象也要使用 Base64URL 算法转成字符串

# 3.3 Signature

Signature 部分是对前两部分的签名，防止数据篡改。

首先，需要指定一个密钥（secret）。这个密钥只有服务器才知道，不能泄露给用户。然后，使用 Header 里面指定的签名算法（默认是 HMAC SHA256），按照下面的公式产生签名。


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

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

# 3.4 Base64URL

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

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

# 四、JWT 的使用方式

客户端收到服务器返回的 JWT，可以储存在 Cookie 里面，也可以储存在 localStorage。

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


Authorization: Bearer <token>

另一种做法是，跨域的时候，JWT 就放在 POST 请求的数据体里面。

# 五、JWT 的几个特点

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

（2）JWT 不加密的情况下，不能将秘密数据写入 JWT。

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

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

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

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

# node.js(Egg)的jsonwebtoken的使用

# Install (opens new window)


$ npm install jsonwebtoken

# Usage（使用）

# jwt.sign(payload, secretOrPrivateKey, [options, callback]) 生成token

(异步) 如果有回调 token 将在回调或者erro 中存在


jwt.sign({ foo: 'bar' }, privateKey, { algorithm: 'RS256' }, function(err, token) {
  console.log(token);
});

(同步) 将以字符串的形式传出


1
var jwt = require('jsonwebtoken');
var token = jwt.sign({ foo: 'bar' }, 'shhhhh');
2
var privateKey = fs.readFileSync('private.key');
var token = jwt.sign({ foo: 'bar' }, privateKey, { algorithm: 'RS256' });

# payload

传入的是一个对象格式的，如果不是对象格式的默认调取JSON.stringify

# secretOrPrivateKey (一般为密钥字符窜对象格式未尝试)

是一个字符串、缓冲区或对象，其中包含HMAC算法的密钥或RSA和ECDSA的PEM编码的私钥。对于带有passphrase的私钥，可以使用对象{key, passphrase}(基于加密文档)，在这种情况下，请确保传递了算法选项。

# options

algorithm (default: HS256)
expiresIn: 单位为秒或描述时间跨度的字符串 (days, hours, etc)。

例如:60，"2 days"，"10h"，"7d"。数值被解释为秒数。如果你使用一个字符串，确保你提供了时间单位(天，小时，等等)，否则默认使用毫秒单位(“120”等于“120ms”)

notBefore: 单位为秒或描述时间跨度的字符串 (days, hours, etc)。

audience
issuer
jwtid
subject
noTimestamp
header
keyid

mutatePayload: 如果为true, sign函数将直接修改payload对象。如果在声明应用到有效负载之后，但在有效负载被编码到令牌之前，您需要它的原始引用，那么这是很有用的。

# 一般生成token使用

  // token密钥和时间
  this.config.jwt = {
      secret: 'token',
      expiresIn: 60 * 60 * 24, // 1天过期
  };
  const token = JWT.sign({
          id: res.id,
          userName: res.user,
      },
      this.config.jwt.secret, {
          expiresIn: this.config.jwt.expiresIn,
      }
  );
  data = {
      id: res.id,
      token
  };

# verify (验证token)

（异步）如果提供了回调，则函数将异步操作。如果签名有效且可选的有效期，受众或发行者有效，则使用解码后的有效负载调用回调。如果没有，它将被错误调用。

（同步）如果未提供回调，则函数将同步执行。如果签名有效且可选的有效期限，受众或发行者有效，则返回解码后的有效负载。如果没有，它将抛出错误。

    return async function(ctx, next) {
        const {
            whiteList,
            secret
        } = ctx.app.config.jwt;
        const isRole = whiteList.includes(ctx.request.path);
        if (isRole) {
            // 拿到传会数据的header 中的token值
            const token = ctx.request.header.authorization ? ctx.request.header.authorization.split(' ')[1] : null;
            if (!token) {
                ctx.returnBody('未登录,请先登录', 401, 401);
            } else {
                try {
                    const loginUser = jwt.verify(token, secret);
                    await next();
                } catch (error) {
                    ctx.returnBody(error, 402, 401);
                }
            }
        } else {
            await next();
        }
    };

# 错误回调


jwt.verify(token, 'shhhhh', function(err, decoded) {
  if (err) {
    /*
      err = {
        name: 'TokenExpiredError',
        message: 'jwt expired',
        expiredAt: 1408621000
      }
    */
  }
});

← Sequelize