jwt是什麼?php jwt類封裝和使用

名稱正在更新……發表於2020-10-23

JWT是什麼

JWT是json web token縮寫。它將使用者資訊加密到token裡,伺服器不儲存任何使用者資訊。伺服器通過使用儲存的金鑰驗證token的正確性,只要正確即通過驗證。基於token的身份驗證可以替代傳統的cookie+session身份驗證方法。

JWT由三個部分組成:header.payload.signature

header部分:

 

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

對應base64UrlEncode編碼為:eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9
說明:該欄位為json格式。alg欄位指定了生成signature的演算法,預設值為 HS256,typ預設值為JWT


payload部分:

 

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

對應base64UrlEncode編碼為:eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ
說明:該欄位為json格式,表明使用者身份的資料,可以自己自定義欄位,很靈活。sub 面向的使用者,name 姓名 ,iat 簽發時間。例如可自定義示例如下:

 

{
    "iss": "admin",          //該JWT的簽發者
    "iat": 1535967430,        //簽發時間
    "exp": 1535974630,        //過期時間
    "nbf": 1535967430,         //該時間之前不接收處理該Token
    "sub": "www.admin.com",   //面向的使用者
    "jti": "9f10e796726e332cec401c569969e13e"   //該Token唯一標識
}

signature部分:

 

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

對應的簽名為:keH6T3x1z7mmhKL1T3r9sQdAxxdzB6siemGMr_6ZOwU


最終得到的JWT的Token為(header.payload.signature):eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.keH6T3x1z7mmhKL1T3r9sQdAxxdzB6siemGMr_6ZOwU
說明:對header和payload進行base64UrlEncode編碼後進行拼接。通過key(這裡是123456)進行HS256演算法簽名。

JWT使用流程

  1. 初次登入:使用者初次登入,輸入使用者名稱密碼
  2. 密碼驗證:伺服器從資料庫取出使用者名稱和密碼進行驗證
  3. 生成JWT:伺服器端驗證通過,根據從資料庫返回的資訊,以及預設規則,生成JWT
  4. 返還JWT:伺服器的HTTP RESPONSE中將JWT返還
  5. 帶JWT的請求:以後客戶端發起請求,HTTP REQUEST
  6. HEADER中的Authorizatio欄位都要有值,為JWT
  7. 伺服器驗證JWT

PHP如何實現JWT

作者使用的是PHP 7.0.31,不廢話,直接上程式碼,新建jwt.php,複製貼上如下:


 

<?php
/**
 * PHP實現jwt
 */
class Jwt {

    //頭部
    private static $header=array(
        'alg'=>'HS256', //生成signature的演算法
        'typ'=>'JWT'    //型別
    );

    //使用HMAC生成資訊摘要時所使用的金鑰
    private static $key='123456';


    /**
     * 獲取jwt token
     * @param array $payload jwt載荷   格式如下非必須
     * [
     *  'iss'=>'jwt_admin',  //該JWT的簽發者
     *  'iat'=>time(),  //簽發時間
     *  'exp'=>time()+7200,  //過期時間
     *  'nbf'=>time()+60,  //該時間之前不接收處理該Token
     *  'sub'=>'www.admin.com',  //面向的使用者
     *  'jti'=>md5(uniqid('JWT').time())  //該Token唯一標識
     * ]
     * @return bool|string
     */
    public static function getToken(array $payload)
    {
        if(is_array($payload))
        {
            $base64header=self::base64UrlEncode(json_encode(self::$header,JSON_UNESCAPED_UNICODE));
            $base64payload=self::base64UrlEncode(json_encode($payload,JSON_UNESCAPED_UNICODE));
            $token=$base64header.'.'.$base64payload.'.'.self::signature($base64header.'.'.$base64payload,self::$key,self::$header['alg']);
            return $token;
        }else{
            return false;
        }
    }


    /**
     * 驗證token是否有效,預設驗證exp,nbf,iat時間
     * @param string $Token 需要驗證的token
     * @return bool|string
     */
    public static function verifyToken(string $Token)
    {
        $tokens = explode('.', $Token);
        if (count($tokens) != 3)
            return false;

        list($base64header, $base64payload, $sign) = $tokens;

        //獲取jwt演算法
        $base64decodeheader = json_decode(self::base64UrlDecode($base64header), JSON_OBJECT_AS_ARRAY);
        if (empty($base64decodeheader['alg']))
            return false;

        //簽名驗證
        if (self::signature($base64header . '.' . $base64payload, self::$key, $base64decodeheader['alg']) !== $sign)
            return false;

        $payload = json_decode(self::base64UrlDecode($base64payload), JSON_OBJECT_AS_ARRAY);

        //簽發時間大於當前伺服器時間驗證失敗
        if (isset($payload['iat']) && $payload['iat'] > time())
            return false;

        //過期時間小宇當前伺服器時間驗證失敗
        if (isset($payload['exp']) && $payload['exp'] < time())
            return false;

        //該nbf時間之前不接收處理該Token
        if (isset($payload['nbf']) && $payload['nbf'] > time())
            return false;

        return $payload;
    }




    /**
     * base64UrlEncode   https://jwt.io/  中base64UrlEncode編碼實現
     * @param string $input 需要編碼的字串
     * @return string
     */
    private static function base64UrlEncode(string $input)
    {
        return str_replace('=', '', strtr(base64_encode($input), '+/', '-_'));
    }

    /**
     * base64UrlEncode  https://jwt.io/  中base64UrlEncode解碼實現
     * @param string $input 需要解碼的字串
     * @return bool|string
     */
    private static function base64UrlDecode(string $input)
    {
        $remainder = strlen($input) % 4;
        if ($remainder) {
            $addlen = 4 - $remainder;
            $input .= str_repeat('=', $addlen);
        }
        return base64_decode(strtr($input, '-_', '+/'));
    }

    /**
     * HMACSHA256簽名   https://jwt.io/  中HMACSHA256簽名實現
     * @param string $input 為base64UrlEncode(header).".".base64UrlEncode(payload)
     * @param string $key
     * @param string $alg   演算法方式
     * @return mixed
     */
    private static function signature(string $input, string $key, string $alg = 'HS256')
    {
        $alg_config=array(
            'HS256'=>'sha256'
        );
        return self::base64UrlEncode(hash_hmac($alg_config[$alg], $input, $key,true));
    }
}

    //***********測試和官網是否匹配begin****************************
    $payload=array('sub'=>'1234567890','name'=>'John Doe','iat'=>1516239022);
    $jwt=new Jwt;
    $token=$jwt->getToken($payload);
    echo "<pre>";
    echo $token;
    
    //對token進行驗證簽名
    $getPayload=$jwt->verifyToken($token);
    echo "<br><br>";
    var_dump($getPayload);
    echo "<br><br>";
    //測試和官網是否匹配end
    
    
    //自己使用測試begin
    $payload_test=array('iss'=>'admin','iat'=>time(),'exp'=>time()+7200,'nbf'=>time(),'sub'=>'www.admin.com','jti'=>md5(uniqid('JWT').time()));;
    $token_test=Jwt::getToken($payload_test);
    echo "<pre>";
    echo $token_test;
    
    //對token進行驗證簽名
    $getPayload_test=Jwt::verifyToken($token_test);
    echo "<br><br>";
    var_dump($getPayload_test);
    echo "<br><br>";
    //自己使用時候end

 

相關文章