python jwt如何在每个请求都校验

原创

mob64ca12efd81c 2024-09-26 04:59:19 ©著作权

文章标签 json python 中间件 文章分类 Python 后端开发

©著作权归作者所有：来自51CTO博客作者mob64ca12efd81c的原创作品，请联系作者获取转载授权，否则将追究法律责任

使用Python JWT进行每个请求的校验方案

在现代Web应用中，安全性是至关重要的。JWT（JSON Web Tokens）作为一种自包含的验证机制，常用于用户身份验证和信息传递。为了确保用户的安全，每一个API请求都需进行JWT的有效性校验。本文将提供一个基于Python的实现方案，并通过示例代码进行演示。

方案概述

该方案包括以下几个主要组件：

用户身份验证和JWT生成。
中间件用来校验每个请求中的JWT。
简单的用户接口供测试。

以下是项目的类图，描述了系统的主要组成部分：

classDiagram
    class User {
        +id: int
        +username: str
        +password: str
        +generate_jwt(): str
    }
    
    class AuthMiddleware {
        +__init__(app)
        +check_jwt(token: str)
    }
    
    class UserService {
        +authenticate(username: str, password: str)
    }

    User --> UserService : uses
    AuthMiddleware --> User : access

代码实现

1. 安装依赖

首先，确保安装了Flask和PyJWT库。可以使用以下命令安装：

pip install Flask PyJWT

2. 用户模型和JWT生成

在用户模型类中，我们将实现JWT的生成逻辑。

import jwt
import datetime

SECRET_KEY = 'your_secret_key'

class User:
    def __init__(self, id, username, password):
        self.id = id
        self.username = username
        self.password = password
    
    def generate_jwt(self):
        token = jwt.encode({
            'id': self.id,
            'exp': datetime.datetime.utcnow() + datetime.timedelta(hours=1)
        }, SECRET_KEY, algorithm='HS256')
        return token

3. 身份验证服务

接下来，我们需要一个服务来处理用户的登录及JWT的生成。

class UserService:
    def authenticate(self, username, password):
        # 假设我们有一个用户字典用于简单模拟
        users = {
            'testuser': 'testpassword'
        }
        
        if username in users and users[username] == password:
            user = User(id=1, username=username, password=password)
            return user.generate_jwt()
        return None

4. JWT校验中间件

随后的步骤是创建一个中间件来校验每个请求中的JWT。

from flask import Flask, request, jsonify

class AuthMiddleware:
    def __init__(self, app):
        self.app = app
        app.before_request(self.check_jwt)

    def check_jwt(self):
        token = request.headers.get('Authorization')
        if not token:
            return jsonify({'message': 'Missing token!'}), 401
        
        try:
            jwt.decode(token, SECRET_KEY, algorithms=['HS256'])
        except jwt.ExpiredSignatureError:
            return jsonify({'message': 'Token expired!'}), 401
        except jwt.InvalidTokenError:
            return jsonify({'message': 'Invalid token!'}), 401

5. 整合Flask应用

最后，我们创建Flask应用并整合上述组件。

app = Flask(__name__)
auth_service = UserService()
AuthMiddleware(app)

@app.route('/login', methods=['POST'])
def login():
    data = request.json
    token = auth_service.authenticate(data['username'], data['password'])
    if token:
        return jsonify({'token': token}), 200
    return jsonify({'message': 'Invalid credentials!'}), 401

@app.route('/protected', methods=['GET'])
def protected():
    return jsonify({'message': 'This is a protected route!'}), 200

if __name__ == '__main__':
    app.run(debug=True)