PyJWT，一个超酷的python库

大家好，我是木木。今天给大家分享一个超酷的 Python 库，PyJWT。

PyJWT 是一个允许你在Python应用中轻松处理JSON Web Tokens (JWT) 的库。它支持JWT的生成、解析和验证，非常适用于需要安全身份验证的现代Web和移动应用。

核心特点

易于使用：

PyJWT 提供简洁的API，使得生成和验证JWT变得非常直接。

灵活支持：

支持多种加密算法，包括HS256、RS256等，满足不同的安全需求。

轻量高效：

该库设计精简，依赖少，易于集成到任何Python项目中。

最佳实践

项目地址：https://github.com/jpadilla/pyjwt

安装方法

通过pip安装PyJWT非常简单：

pip install PyJWT

基本用法

生成 JWT 为了生成一个JWT，需要一个载荷和一个密钥。这是一个示例：

>>> import jwt
>>> from datetime import datetime, timedelta
>>> payload = {'user_id': 123, 'exp': datetime.utcnow() + timedelta(hours=1)}
>>> secret = 'your-secret'
>>> encoded_jwt = jwt.encode(payload, secret, algorithm='HS256')
>>> print(f"Encoded JWT: {encoded_jwt}")
Encoded JWT: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2lkIjoxMjMsImV4cCI6MTcxNTI2MTQ3MH0.rtbkWLW64HrSz7emMKRzMhcc4VI_ZFIYUJcCErhISDo

解码 JWT 并处理错误

对于JWT的解码过程，不仅可以处理过期问题，还可以捕获和处理其他常见错误，如签名验证失败。以下是一个包含多种错误处理的解码JWT示例：

import jwt
from datetime import datetime, timedelta
from jwt import ExpiredSignatureError, InvalidSignatureError, DecodeError

# 示例JWT和密钥
secret = 'your-secret'
payload = {'user_id': 123, 'exp': datetime.utcnow() + timedelta(seconds=10)}  # 短暂的过期时间用于测试
encoded_jwt = jwt.encode(payload, secret, algorithm='HS256')

# 通过time.sleep引入延时以测试过期JWT
import time
time.sleep(10)  # 等待JWT过期

try:
    # 尝试解码JWT
    decoded_jwt = jwt.decode(encoded_jwt, secret, algorithms=["HS256"])
    print(f"Decoded JWT: {decoded_jwt}")
except ExpiredSignatureError:
    print("Token has expired.")
except InvalidSignatureError:
    print("Invalid signature. The token's signature did not match the expected signature.")
except DecodeError:
    print("Decode error. The token could not be decoded because of a wrong format or header info.")
except Exception as e:
    print(f"An unexpected error occurred: {str(e)}")

高级功能示例

错误处理和高级用法

这个示例展示如何处理JWT过期的情况，并且添加自定义声明：

import jwt
from datetime import datetime, timedelta

payload = {'user_id': 123, 'exp': datetime.utcnow() + timedelta(seconds=30)}
secret = 'your-secret'

encoded_jwt = jwt.encode(payload, secret, algorithm='HS256')
print(f"JWT: {encoded_jwt}")

try:
    # 此处故意等待JWT过期
    time.sleep(35)  # 导入time模块
    decoded_jwt = jwt.decode(encoded_jwt, secret, algorithms=["HS256"])
except jwt.ExpiredSignatureError:
    print("Token has expired")

print(f"Decoded JWT: {decoded_jwt}")