快捷導(dǎo)航

Python JWT 介紹和使用詳解

更新時(shí)間：2021年05月12日 10:09:06 作者：ChaosMoor

這篇文章主要介紹了Python JWT 介紹和使用詳解，文中通過(guò)示例代碼介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值，需要的朋友們下面隨著小編來(lái)一起學(xué)習(xí)學(xué)習(xí)吧

1. JWT 介紹

jwt（ JSON Web Tokens ），是一種開(kāi)發(fā)的行業(yè)標(biāo)準(zhǔn) RFC 7519 ，用于安全的表示雙方之間的聲明。目前，jwt廣泛應(yīng)用在系統(tǒng)的用戶(hù)認(rèn)證方面，特別是現(xiàn)在前后端分離項(xiàng)目
jwt認(rèn)證流程：

在項(xiàng)目開(kāi)發(fā)中，一般會(huì)按照上圖所示的過(guò)程進(jìn)行認(rèn)證，即：用戶(hù)登錄成功之后，服務(wù)端給用戶(hù)瀏覽器返回一個(gè) token，以后用戶(hù)瀏覽器要攜帶 token 再去向服務(wù)端發(fā)送請(qǐng)求，服務(wù)端校驗(yàn) token 的合法性，合法則給用戶(hù)看數(shù)據(jù)，否則，返回一些錯(cuò)誤信息

傳統(tǒng)token方式和jwt在認(rèn)證方面有什么差異？

傳統(tǒng) token 方式：用戶(hù)登錄成功后，服務(wù)端生成一個(gè)隨機(jī) token 給用戶(hù)，并且在服務(wù)端(數(shù)據(jù)庫(kù)或緩存)中保存一份 token，以后用戶(hù)再來(lái)訪問(wèn)時(shí)需攜帶 token，服務(wù)端接收到 token 之后，去數(shù)據(jù)庫(kù)或緩存中進(jìn)行校驗(yàn) token 的是否超時(shí)、是否合法
jwt 方式：用戶(hù)登錄成功后，服務(wù)端通過(guò) jwt 生成一個(gè)隨機(jī) token 給用戶(hù)（服務(wù)端無(wú)需保留 token），以后用戶(hù)再來(lái)訪問(wèn)時(shí)需攜帶token，服務(wù)端接收到 token 之后，通過(guò) jwt 對(duì) token 進(jìn)行校驗(yàn)是否超時(shí)、是否合法

2. JWT 創(chuàng)建 token

2.1 JWT 生成原理

jwt 的生成 token 格式如下，即：由 . 連接的三段字符串組成

eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lI
iwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c

生成規(guī)則如下：

第一段 HEADER 部分，固定包含算法和 token 類(lèi)型，對(duì)此 json 進(jìn)行 base64url 加密，這就是 token
的第一段

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

第二段 PAYLOAD 部分，包含一些數(shù)據(jù)，對(duì)此json進(jìn)行base64url加密，這就是token的第二段

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

第三段 SIGNATURE 部分，把前兩段的 base64url 密文通過(guò). 拼接起來(lái)，然后對(duì)其進(jìn)行 HS256 加密，再然后對(duì)hs256 密文進(jìn)行 base64url 加密，最終得到 token 的第三段

base64url(
	HMACSHA256(
		base64UrlEncode(header) + "." + base64UrlEncode(payload),
	your-256-bit-secret (秘鑰加鹽)
	)
)

最后將三段字符串通過(guò) . 拼接起來(lái)就生成了 jwt 的 token

注意：base64url 加密是先做 base64 加密，然后再將 - 替代 + 及 _ 替代 /

2.2 JWT 校驗(yàn) token 原理

一般在認(rèn)證成功后，把 jwt 生成的 token 返回給用戶(hù)，以后用戶(hù)再次訪問(wèn)時(shí)候需要攜帶 token，此時(shí) jwt 需要對(duì)token 進(jìn)行超時(shí)及合法性校驗(yàn)
獲取 token 之后，會(huì)按照以下步驟進(jìn)行校驗(yàn)：

將token分割成 header_segment 、payload_segment 、crypto_segment 三部分

JWT_TOKEN =
"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c"

signing_input, crypto_segment = JWT_TOKEN.rsplit('.', 1)
header_segment, payload_segment = signing_input.split('.', 1)

對(duì)第一部分header_segment 進(jìn)行 base64url 解密，得到 header

對(duì)第二部分payload_segment 進(jìn)行 base64url 解密，得到 payload

對(duì)第三部分crypto_segment 進(jìn)行 base64url 解密，得到 signature，針對(duì) signature 部分?jǐn)?shù)據(jù)進(jìn)行合法性校驗(yàn)

拼接前兩段密文，即：signing_input
從第一段明文中獲取加密算法，默認(rèn)：HS256
使用算法+鹽對(duì) signing_input 進(jìn)行加密，將得到的結(jié)果和 signature 密文進(jìn)行比較

3. 代碼實(shí)現(xiàn)

基于 Python 的 pyjwt 模塊創(chuàng)建 jwt 的 token

安裝

pip3 install pyjwt

實(shí)現(xiàn)

from datetime import datetime, timedelta

import jwt


class JwtToken(object):

    _salt = "@^4_00wedv**pi)+(!w1rwi=d3q4l=ie=g-u$s8jevmj*zgg2h" 

    _expire_message = dict(code=1200, msg="token 已經(jīng)失效")

    _unknown_error_message = dict(code=4200, msg="token 解析失敗")

    @classmethod
    def generate_token(cls, payload: dict) -> str:
        headers = dict(typ="jwt", alg="HS256")
        resut = jwt.encode(payload=payload, key=cls._salt, algorithm="HS256", headers=headers)
        return resut

    @classmethod
    def parse_token(cls, token: str) -> tuple:
        verify_status = False
        try:
            payload_data = jwt.decode(token, cls._salt, algorithms=['HS256'])
            verify_status = True
        except jwt.ExpiredSignatureError:
            payload_data = cls._expire_message
        except Exception as _err:
            payload_data = cls._unknown_error_message
        return verify_status, payload_data


if __name__ == '__main__':
    TEST_DATA = dict(name="mooor", exp=datetime.utcnow() - timedelta(seconds=1))
    token = JwtToken.generate_token(TEST_DATA)
    print(token)
    payload = JwtToken.parse_token(token)
    print(payload)

注意：exp 務(wù)必選擇 UTC 時(shí)間

Expiration time will be compared to the current UTC time (as given by timegm(datetime.utcnow().utctimetuple())), so be sure to use a UTC timestamp or datetime in encoding

4. 參數(shù)介紹

4.1 示例：

import jwt
import datetime

dic = {
    'exp': datetime.datetime.utcnow() + datetime.timedelta(days=1),  # 過(guò)期時(shí)間
    'iat': datetime.datetime.utcnow(),  #  開(kāi)始時(shí)間
    'iss': 'ChaosMoor',                 #  簽名
    'data': {                           #  內(nèi)容，一般存放該用戶(hù)id和開(kāi)始時(shí)間
        'a': 1,
        'b': 2,
    },
}


token = jwt.encode(dic, 'secret', algorithm='HS256')                            # 加密生成字符串
print(token)

payload = jwt.decode(token, 'secret', issuer='lianzong', algorithms=['HS256'])  # 解密，校驗(yàn)簽名
print(s)
print(type(s))

dic 有官方指定的 key，程序在解密的時(shí)候會(huì)根據(jù) key 的 Value 判斷是否合法。這些 key 有：

"exp"：在生成 token 時(shí)，可以設(shè)置該 token 的有效時(shí)間，如果我們?cè)O(shè)置 1 天過(guò)期，1 天后我們?cè)俳馕龃?token 會(huì)拋出