FastAPI中JWT令牌的安全高效生成与验证策略

FastAPI中JWT令牌的安全且高效的生成与验证策略


title: JWT令牌在FastAPI中的安全高效实现之道?
date: 2025/06/10 09:02:35
updated: 2025/06/10 09:02:35
author: cmdragon

excerpt:
JSON Web Token(JWT)是一种开放标准,用于安全地在各方之间传输声明性信息,它由头部、负载和签名三部分构成。在FastAPI里,JWT常被用于用户身份的认证、API的授权以及跨服务的通信。借助python-jose库来生成和验证JWT,关键步骤涵盖配置安全参数、生成访问令牌、实现登录接口以及验证机制等。生成令牌时得设置过期时间,以此避免令牌被长期非法使用,验证时则通过中间件来检查令牌的有效性。另外,还能通过刷新令牌的机制来更新访问令牌,从而保障系统的安全性和用户的使用体验。

categories:

  • 后端开发
  • FastAPI

tags:

  • JWT
  • FastAPI
  • 令牌生成
  • 令牌验证
  • 身份认证
  • 安全通信
  • 无状态会话

第四章:JWT令牌的生成与验证机制

1.1 JWT的基本概念

JSON Web Token(JWT)属于开放标准(RFC 7519),能够在两方之间安全地传递声明性信息。它由三个部分构成:

  • 头部(Header):用于描述所采用的算法以及令牌的类型
  • 负载(Payload):承载用户的数据(例如用户ID)以及各类声明(像过期时间等)
  • 签名(Signature):是用于验证令牌完整性的加密字符串

JWT在FastAPI中的常见应用场景如下:

  • 对用户身份进行认证
  • 对API接口进行授权
  • 实现跨服务的安全通信
  • 进行无状态的会话管理

2. 环境搭建

建议使用虚拟环境来安装所需的依赖库,执行以下命令进行安装:

pip install fastapi==0.95.2 python-jose[cryptography]==3.3.0 passlib==1.7.4 bcrypt==4.0.1 uvicorn==0.22.0

3.1 核心配置类

from datetime import datetime, timedelta
from jose import JWTError, jwt
from passlib.context import CryptContext
from pydantic import BaseModel

# 安全相关配置
SECRET_KEY = "your-secret-key-here"  # 在生产环境中应从环境变量中获取
ALGORITHM = "HS256"
ACCESS_TOKEN_EXPIRE_MINUTES = 30

# 密码哈希配置
pwd_context = CryptContext(schemes=["bcrypt"], deprecated="auto")

class Token(BaseModel):
    access_token: str
    token_type: str

class TokenData(BaseModel):
    username: str | None = None

3.2 令牌生成函数

def generate_access_token(data: dict, expires_delta: timedelta | None = None):
    encoded_data = data.copy()
    if expires_delta:
        expiration_time = datetime.utcnow() + expires_delta
    else:
        expiration_time = datetime.utcnow() + timedelta(minutes=15)
    encoded_data["exp"] = expiration_time
    encoded_jwt = jwt.encode(encoded_data, SECRET_KEY, algorithm=ALGORITHM)
    return encoded_jwt

3.3 登录接口的实现

from fastapi import APIRouter, Depends, HTTPException, status
from fastapi.security import OAuth2PasswordRequestForm

router = APIRouter()

@router.post("/token", response_model=Token)
async def obtain_access_token(form_data: OAuth2PasswordRequestForm = Depends()):
    user = verify_user(fake_users_db, form_data.username, form_data.password)
    if not user:
        raise HTTPException(
            status_code=status.HTTP_401_UNAUTHORIZED,
            detail="用户名或密码不正确",
            headers={"WWW-Authenticate": "Bearer"},
        )
    access_token_duration = timedelta(minutes=ACCESS_TOKEN_EXPIRE_MINUTES)
    access_token = generate_access_token(
        data={"sub": user.username}, expires_delta=access_token_duration
    )
    return {"access_token": access_token, "token_type": "bearer"}

4.1 令牌验证中间件

from fastapi.security import OAuth2PasswordBearer

oauth2_scheme = OAuth2PasswordBearer(tokenUrl="token")

async def get_current_active_user(token: str = Depends(oauth2_scheme)):
    auth_exception = HTTPException(
        status_code=status.HTTP_401_UNAUTHORIZED,
        detail="无法验证凭证",
        headers={"WWW-Authenticate": "Bearer"},
    )
    try:
        decoded_payload = jwt.decode(token, SECRET_KEY, algorithms=[ALGORITHM])
        username_from_payload: str = decoded_payload.get("sub")
        if username_from_payload is None:
            raise auth_exception
        token_info = TokenData(username=username_from_payload)
    except JWTError:
        raise auth_exception
    user = retrieve_user(fake_users_db, username=token_info.username)
    if user is None:
        raise auth_exception
    return user

4.2 受保护路由示例

@router.get("/users/profile/")
async def view_user_profile(current_user: User = Depends(get_current_active_user)):
    return current_user

5. 令牌刷新机制

实现令牌刷新的接口:

@router.post("/renew")
async def renew_access_token(refresh_token: str):
    try:
        decoded_payload = jwt.decode(refresh_token, SECRET_KEY, algorithms=[ALGORITHM])
        username = decoded_payload.get("sub")
        if username is None:
            raise HTTPException(status_code=400, detail="无效的令牌")

        # 执行具体的数据库查询来检查用户是否存在
        user = find_user(username)
        if not user:
            raise HTTPException(status_code=404, detail="用户未找到")

        new_token = generate_access_token(data={"sub": user.username})
        return {"access_token": new_token}

    except JWTError:
        raise HTTPException(status_code=401, detail="无效的令牌")

课后小测验

  1. 为何JWT需要设置过期时间?
    A) 降低服务器内存占用
    B) 防止令牌被长期非法使用
    C) 提升加密强度
    D) 简化开发流程

  2. 下列哪种行为会损害JWT的安全性?
    A) 使用HTTPS传输令牌
    B) 将敏感数据存储在负载部分
    C) 定期更换加密密钥
    D) 验证签名算法

  3. 如何处理令牌过期的状况?
    A) 返回500错误
    B) 要求用户重新登录
    C) 利用refresh token获取新令牌
    D) 自动延长过期时间

答案:
1. B - 设置过期时间能够限定令牌的有效时长,从而降低令牌被长期非法使用的风险
2. B - 尽管负载中的内容经过加密,但仍可被解码,所以不应在其中存储敏感信息
3. C - 最佳的做法是通过refresh token机制来更新访问令牌

常见错误解决办法

  1. 401 Unauthorized: Could not validate credentials
  2. 缘由:令牌格式有误或者签名不匹配
  3. 解决方式:检查请求头中Bearer token的格式,验证密钥是否一致

  4. 422 Validation Error

  5. 缘由:请求体和Pydantic模型不相符
  6. 预防措施:采用精准的模型定义,添加字段验证规则

  7. 500 Internal Server Error: JWTError

  8. 缘由:令牌解码失败或者算法不匹配
  9. 处理方法:捕获JWTError异常,返回401状态码
  10. 检查要点:确保服务端使用的算法与生成令牌时所使用的算法一致

  11. AttributeError: 'NoneType' has no attribute 'username'

  12. 缘由:数据库查询返回了空值
  13. 修复办法:在数据库查询之后添加空值检查
  14. 优化方向:使用Optional类型注解并进行空值处理

最佳实践建议

  1. 在生产环境中运用RSA非对称加密(RS256算法)
  2. 把密钥存储在环境变量或者密钥管理服务当中
  3. 设定合理的令牌有效时长(一般访问令牌为15分钟,刷新令牌为7天)
  4. 构建令牌撤销清单(黑名单机制)

余下文章内容请点击跳转至 个人博客页面 或者 扫码关注或者微信搜一搜:编程智域 前端至全栈交流与成长,阅读完整的文章:JWT令牌如何在FastAPI中实现安全又高效的生成与验证? | cmdragon's Blog

往期文章归档:

文章整理自互联网,只做测试使用。发布者:Lomu,转转请注明出处:https://www.it1024doc.com/12607.html

(0)
LomuLomu
上一篇 2025 年 6 月 21 日
下一篇 2025 年 6 月 21 日

相关推荐

  • Java MyBatis 面试题

    谈谈MyBatis的启动过程? 加载配置文件: MyBatis的配置文件是一个XML文件,包含了数据库连接信息、映射文件的位置等配置信息。在启动过程中,MyBatis会读取并解析这个配置文件。 创建SqlSessionFactory对象: SqlSessionFactory是MyBatis的核心对象,用于创建SqlSession对象。在启动过程中,MyBat…

    未分类 2025 年 1 月 15 日
    24200
  • 破解OceanBase存储引擎读放大难题的方法

    破解OceanBase存储引擎读放大难题的办法 首先给大家推荐一下OceanBase开源负责人老纪的公众号“老纪的技术唠嗑局”,这里会持续更新和#数据库、#AI、#技术架构相关的各类技术内容。感兴趣的朋友可以关注哦! 前言 OceanBase的LSM-Tree存储引擎本身有着高效的写入性能,它既能通过旁路导入来高效处理定期的批量数据同步,还能承接一些实时数据…

    2025 年 7 月 20 日
    3500
  • Python 潮流周刊#85:让 AI 帮你写出更好的代码(摘要)

    本周刊由 Python猫 出品,精心筛选国内外的 250+ 信息源,为你挑选最值得分享的文章、教程、开源项目、软件工具、播客和视频、热门话题等内容。愿景:帮助所有读者精进 Python 技术,并增长职业和副业的收入。 分享了 12 篇文章,12 个开源项目,1 则音视频,全文 2300 字。 以下是本期摘要: 🦄文章&教程 ① 如果一直要求 LLM “写出更…

    未分类 2025 年 1 月 12 日
    27500
  • 2024 DataGrip最新激活码,DataGrip永久免费激活码2025-01-19 更新

    DataGrip 2024最新激活码 以下是最新的DataGrip激活码,更新时间:2025-01-19 🔑 激活码使用说明 1️⃣ 复制下方激活码 2️⃣ 打开 DataGrip 软件 3️⃣ 在菜单栏中选择 Help -> Register 4️⃣ 选择 Activation Code 5️⃣ 粘贴激活码,点击 Activate ⚠️ 必看!必看! 🔥 …

    2025 年 1 月 19 日
    34600
  • DataGrip 2024激活教程及破解码(亲测有效)

    DataGrip 2024激活教程及破解码(亲测有效) 这篇教程适用于所有JetBrains系列软件,包括DataGrip。接下来,我将向大家展示如何通过简单的图文步骤,成功激活DataGrip至2099年。通过这个方法,你不仅能轻松激活最新版本,也能适用于旧版本的激活。 首先,先看一下成功激活的截图,我们可以看到DataGrip已经成功激活,且有效期延续至…

    2025 年 4 月 22 日
    34200

发表回复

您的邮箱地址不会被公开。 必填项已用 * 标注

联系我们

400-800-8888

在线咨询: QQ交谈

邮件:admin@example.com

工作时间:周一至周五,9:30-18:30,节假日休息

关注微信