PHP扩展 使用JWT（JSON WEB TOKEN）

Json web token (JWT), 是为了在网络应用环境间传递声明而执行的一种基于JSON的开放标准（(RFC 7519).该token被设计为紧凑且安全的，特别适用于分布式站点的单点登录（SSO）场景。JWT的声明一般被用来在身份提供者和服务提供者间传递被认证的用户身份信息，以便于从资源服务器获取资源，也可以增加一些额外的其它业务逻辑所必须的声明信息，该token也可直接被用于认证，也可被加密。

基于token的鉴权机制

基于token的鉴权机制类似于http协议也是无状态的，它不需要在服务端去保留用户的认证信息或者会话信息。这就意味着基于token认证机制的应用不需要去考虑用户在哪一台服务器登录了，这就为应用的扩展提供了便利。

流程：

用户使用用户名密码来请求服务器

服务器进行验证用户的信息

服务器通过验证发送给用户一个token

客户端存储token，并在每次请求时附送上这个token值

服务端验证token值，并返回数据

这个token必须要在每次请求时传递给服务端，它应该保存在请求头里， 另外，服务端要支持CORS(跨来源资源共享)策略，一般我们在服务端这么做就可以了Access-Control-Allow-Origin: *。

JWT的构成

第一部分我们称它为头部（header),第二部分我们称其为载荷（payload, 类似于飞机上承载的物品)，第三部分是签证（signature).

header

jwt的头部承载两部分信息：

声明类型，这里是jwt

声明加密的算法 通常直接使用 HMAC SHA256

完整的头部如下JSON：

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

playload

载荷就是存放有效信息的地方。有效信息包含三个部分

标准中注册的声明

公共的声明

私有的声明

标准中注册的声明 (建议但不强制使用) ：

iss: jwt签发者

sub: jwt所面向的用户

aud: 接收jwt的一方

exp: jwt的过期时间，这个过期时间必须要大于签发时间

nbf: 定义在什么时间之前，该jwt都是不可用的.

iat: jwt的签发时间

jti: jwt的唯一身份标识，主要用来作为一次性token,从而回避重放攻击。

公共的声明 ：

公共的声明可以添加任何的信息，一般添加用户的相关信息或其他业务需要的必要信息.但不建议添加敏感信息，因为该部分在客户端可解密.

私有的声明 ：

私有声明是提供者和消费者所共同定义的声明，一般不建议存放敏感信息，因为base64是对称解密的，意味着该部分信息可以归类为明文信息。

定义一个payload:

{ 'user':'xiaoming', 'iat':1603362619, 'exp':1603363619)}

signature

jwt的第三部分是一个签证信息，这个签证信息由三部分组成：

header (base64后的)

payload (base64后的)

secret

这个部分需要base64加密后的header和base64加密后的payload使用.连接组成的字符串，然后通过header中声明的加密方式进行加盐secret组合加密，然后就构成了jwt的第三部分。

将这三部分用.连接成一个完整的字符串,构成了最终的jwt:

eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiYWRtaW4iOnRydWV9.TJVA95OrM7E2cBab30RMHrHD

服务端会验证token，如果验证通过就会返回相应的资源。整个流程就是这样的:

总结

优点

因为json的通用性，所以JWT是可以进行跨语言支持的，像JAVA,JavaScript,NodeJS,PHP等很多语言都可以使用。

因为有了payload部分，所以JWT可以在自身存储一些其他业务逻辑所必要的非敏感信息。

便于传输，jwt的构成非常简单，字节占用很小，所以它是非常便于传输的。

它不需要在服务端保存会话信息, 所以它易于应用的扩展

安全相关

不应该在jwt的payload部分存放敏感信息，因为该部分是客户端可解密的部分。

保护好secret私钥，该私钥非常重要。

PHP扩展有如下 可根据版本选择对应插件：官方网站：https://jwt.io/

以Firebase插件举例：

<?php
/**
 * Created by PhpStorm.
 */

require $_SERVER["DOCUMENT_ROOT"] . '/vendor/autoload.php';
use Firebase\JWT\JWT;
use Firebase\JWT\SignatureInvalidException;
use Firebase\JWT\ExpiredException;
use Firebase\JWT\BeforeValidException;


/**
 * JWT  Json Web Token
 * Class JWTToken
 *
 * iss (issuer)：签发人
 * exp (expiration time)：过期时间
 * sub (subject)：主题
 * aud (audience)：受众
 * nbf (Not Before)：生效时间
 * iat (Issued At)：签发时间
 * jti (JWT ID)：编号
 *
 */
class JWTToken
{
    const JWT_SECRET_KEY = JWT_KEY; //安全秘钥
    const JWT_TOKEN_TYPE = 'Bearer'; //token类型
    const JWT_ALGORITHM = 'HS256';  //加密算法

    //----错误异常code定义----
    const ERR_MISSING_TOKEN = 300; //缺少token
    const ERR_MISSING_REFRESH_TOKEN = 301; //缺少 refresh token
    const ERR_ROKEN_EXPIRED = 302; //token过期
    const ERR_SIGNATURE_INVALID = 303; //签名错误
    const ERR_NBF_IAT_INVALID = 304; //签发生效时间错误
    const ERR_UNEXPECTED_VALUE = 305; //jwt参数错误
    const ERR_TOKEN_FORMAT_WRONG = 306; //token格式错误


    /**
     * 签发token
     * @param string $refererDomain 请求域名
     * @param array $userData 用户自定义数据
     * @param int $expireTime 过期时间
     * @return string
     */
    public static function issueToken($refererDomain, $userData = [], $expireTime = 0)
    {
        $time = time();
        $payload = [
            "iss" => $refererDomain, // issuer签发人
            "aud" => $refererDomain, // 受众
            "iat" => $time, // Issued At 签发时间
            "nbf" => $time, // Not Before 生效事件
            //'exp' => time() + 1200,//十分钟过期
            'data' => $userData, // 用户自定义数据
        ];

        if ($expireTime)
        {
            $payload['exp'] = $time + $expireTime;
        }
        JWT::$leeway = 120;
        $jwt = JWT::encode($payload, static::JWT_SECRET_KEY, static::JWT_ALGORITHM);
        return $jwt;
    }

    /**
     * 验证、解析token
     * @param string $token
     * @return array
     */
    public static function verifyToken($token)
    {
        try
        {
            //token解析
            $jwt = JWT::decode($token, static::JWT_SECRET_KEY, [static::JWT_ALGORITHM]);
            return (array)$jwt->data;
        }
        catch (ExpiredException $e)
        {
            throw new Exception("token已经过期", static::ERR_ROKEN_EXPIRED);
        }
        catch (SignatureInvalidException $e)
        {
            throw new Exception("签名错误", static::ERR_SIGNATURE_INVALID);
        }
        catch (BeforeValidException $e)
        {
            throw new Exception("签发生效时间错误", static::ERR_NBF_IAT_INVALID);
        }
        catch(UnexpectedValueException $e)
        {
            throw new Exception("jwt参数错误:".$e->getMessage(), static::ERR_UNEXPECTED_VALUE);
        }
        catch(Exception $e)
        {
            throw $e;
        }
        finally
        {
            //nothing to do
        }
    }

    /**
     * 校验token
     * @throws Exception
     */
    public static function verifyJWTToken()
    {
        $jwtToken = isset($_SERVER['HTTP_AUTHORIZATION']) ? $_SERVER['HTTP_AUTHORIZATION'] : Request::getRequest("jwt_token", "str", "");
        if (empty($jwtToken))
        {
            throw new Exception('缺少token信息', static::ERR_MISSING_TOKEN);
        }

        if(strpos($jwtToken,static::JWT_TOKEN_TYPE) !== 0)
        {
            throw new Exception('token信息格式错误', static::ERR_TOKEN_FORMAT_WRONG);
        }

        $jwtToken=str_replace([static::JWT_TOKEN_TYPE,' '],'',$jwtToken);
        if (empty($jwtToken))
        {
            throw new Exception('缺少token信息', static::ERR_MISSING_TOKEN);
        }

        JWTToken::verifyToken($jwtToken);
    }

    /**
     * 校验refresh_token
     * @throws Exception
     */
    public static function verifyRefreshJWTToken()
    {
        $refreshToken = Request::getRequest("jwt_refresh_token", "str", "", "post");
        if (empty($refreshToken))
        {
            throw new \Exception('缺少refresh token信息', static::ERR_MISSING_REFRESH_TOKEN);
        }
        JWTToken::verifyToken($refreshToken);
    }
}