title: 如何在FastAPI中轻松实现OAuth2认证并保护你的API?

date: 2025/06/09 05:16:05

updated: 2025/06/09 05:16:05

author: cmdragon

excerpt:

OAuth2 是现代应用程序实现安全认证的行业标准协议,通过令牌而非直接使用用户凭证进行授权。FastAPI 提供 OAuth2PasswordBearer 类支持密码授权模式,流程包括用户提交凭证、服务器验证、生成访问令牌及验证令牌有效性。配置安全模块需安装依赖库并创建 security.py,包含密码哈希、验证及 JWT 令牌生成功能。用户认证通过模拟数据库实现,提供登录接口和受保护路由。安全路由保护机制依赖 get_current_user 函数验证令牌。进阶实践包括刷新令牌、权限分级和速率限制,遵循 OWASP 安全规范。

categories:

  • 后端开发
  • FastAPI

tags:

  • OAuth2
  • FastAPI
  • 用户认证
  • JWT
  • 安全路由
  • 密码哈希
  • 令牌机制


扫描二维码

关注或者微信搜一搜:编程智域 前端至全栈交流与成长

探索数千个预构建的 AI 应用,开启你的下一个伟大创意https://tools.cmdragon.cn/

第二章:实现用户认证与 OAuth2 集成

1. OAuth2 的核心概念

OAuth2 是现代应用程序实现安全认证的行业标准协议,其核心思想是通过令牌(Token)而非直接使用用户凭证进行授权。FastAPI

通过内置的 OAuth2PasswordBearer 类提供了开箱即用的支持。

典型的密码授权模式流程:

  1. 用户提交用户名和密码
  2. 服务器验证凭证有效性
  3. 生成有时效性的访问令牌
  4. 客户端使用令牌访问受保护资源
  5. 服务器验证令牌有效性

2. 配置基础安全模块

安装所需依赖库:

pip install fastapi==0.103.1
pip install python-jose[cryptography]==3.3.0
pip install passlib[bcrypt]==1.7.4

创建安全模块 security.py

from datetime import datetime, timedelta
from jose import JWTError, jwt
from passlib.context import CryptContext # 安全配置参数
SECRET_KEY = "your-secret-key-here"
ALGORITHM = "HS256"
ACCESS_TOKEN_EXPIRE = 30 # 分钟 pwd_context = CryptContext(schemes=["bcrypt"], deprecated="auto") def verify_password(plain_password: str, hashed_password: str):
"""验证密码与哈希值是否匹配"""
return pwd_context.verify(plain_password, hashed_password) def get_password_hash(password: str):
"""生成密码哈希值"""
return pwd_context.hash(password) def create_access_token(data: dict):
"""生成JWT访问令牌"""
to_encode = data.copy()
expire = datetime.utcnow() + timedelta(minutes=ACCESS_TOKEN_EXPIRE)
to_encode.update({"exp": expire})
return jwt.encode(to_encode, SECRET_KEY, algorithm=ALGORITHM)

3. 用户认证完整实现

创建用户模型和认证路由:

from fastapi import APIRouter, Depends, HTTPException
from fastapi.security import OAuth2PasswordBearer, OAuth2PasswordRequestForm
from pydantic import BaseModel router = APIRouter() # 模拟数据库中的用户数据
fake_users_db = {
"johndoe": {
"username": "johndoe",
"hashed_password": "$2b$12$EixZaYVK1fsbw1ZfbX3OXePaWxn96p36WQoeG6Lruj3vjPGga7lCy", # secret
"disabled": False,
}
} class User(BaseModel):
username: str
disabled: bool = None class UserInDB(User):
hashed_password: str oauth2_scheme = OAuth2PasswordBearer(tokenUrl="token") async def get_current_user(token: str = Depends(oauth2_scheme)):
"""解析并验证JWT令牌"""
credentials_exception = HTTPException(
status_code=401,
detail="无效的身份凭证",
headers={"WWW-Authenticate": "Bearer"},
)
try:
payload = jwt.decode(token, SECRET_KEY, algorithms=[ALGORITHM])
username: str = payload.get("sub")
if username is None:
raise credentials_exception
except JWTError:
raise credentials_exception user = fake_users_db.get(username)
if user is None:
raise credentials_exception
return UserInDB(**user) @router.post("/token")
async def login(form_data: OAuth2PasswordRequestForm = Depends()):
"""用户登录接口"""
user = fake_users_db.get(form_data.username)
if not user or not verify_password(form_data.password, user["hashed_password"]):
raise HTTPException(status_code=400, detail="用户名或密码错误") access_token = create_access_token(data={"sub": user["username"]})
return {"access_token": access_token, "token_type": "bearer"} @router.get("/users/me")
async def read_users_me(current_user: User = Depends(get_current_user)):
"""获取当前用户信息的受保护路由"""
return current_user

4. 安全路由保护机制

在需要身份验证的路由中添加依赖项:

from fastapi import Depends

@app.get("/protected-route")
async def protected_route(current_user: User = Depends(get_current_user)):
"""需要认证的受保护路由示例"""
return {
"message": "您已成功访问受保护资源",
"current_user": current_user.username
}

5. 课后 Quiz

Q1:当客户端请求缺失Authorization头时,会触发什么HTTP状态码?

A) 401 Unauthorized

B) 403 Forbidden

C) 422 Validation Error

D) 500 Internal Server Error

答案:A

解析:OAuth2PasswordBearer会自动验证请求头,当缺失Authorization头时会返回401状态码,表示需要身份验证

Q2:如何防止JWT令牌被篡改?

A) 使用HTTPS传输

B) 设置短的令牌有效期

C) 使用签名算法验证

D) 所有以上选项

答案:D

解析:签名算法保证令牌完整性,HTTPS防止中间人攻击,短有效期降低泄漏风险,三者结合提供全面防护

6. 常见报错解决方案

问题1:422 Unprocessable Entity

原因:请求体数据不符合Pydantic模型验证规则

解决方法:

  1. 检查请求数据格式是否符合API文档
  2. 在路由参数中添加response_model_exclude_unset=True
  3. 启用调试模式查看详细错误:
app = FastAPI(debug=True)

问题2:401 Unauthorized - Could not validate credentials

原因分析:

  1. 访问令牌过期
  2. 令牌签名不匹配
  3. 用户账户已被禁用

    排查步骤:
  4. 检查令牌有效期设置
  5. 验证SECRET_KEY和ALGORITHM配置一致性
  6. 确认用户状态字段是否有效

预防建议:

  • 在生产环境使用强密钥:openssl rand -hex 32
  • 设置合理的令牌有效期(通常30分钟-2小时)
  • 定期轮换加密密钥

7. 进阶安全实践

  1. 刷新令牌机制:通过独立的刷新令牌获取新访问令牌
  2. 权限分级:基于角色的访问控制(RBAC)实现
# 在令牌中加入角色声明
token_data = {"sub": username, "role": "admin"} # 验证角色中间件
def require_admin(user: User = Depends(get_current_user)):
if user.role != "admin":
raise HTTPException(403, "需要管理员权限")
  1. 速率限制:防止暴力破解攻击
from fastapi.middleware import Middleware
from slowapi import Limiter
from slowapi.util import get_remote_address limiter = Limiter(key_func=get_remote_address)
app = FastAPI(middleware=[Middleware(limiter)])

本实现方案遵循OWASP安全规范,涵盖了密码存储、令牌传输、权限验证等关键安全要素,可直接用于生产环境的基础认证系统搭建。

余下文章内容请点击跳转至 个人博客页面 或者 扫码关注或者微信搜一搜:编程智域 前端至全栈交流与成长,阅读完整的文章:如何在FastAPI中轻松实现OAuth2认证并保护你的API? | cmdragon's Blog

往期文章归档:

如何在FastAPI中轻松实现OAuth2认证并保护你的API?的更多相关文章

  1. 如何在Linux中轻松删除源安装的软件包?

    第1步:安装Stow 在这个例子中,我们使用的是CentOS,因此我们需要扩展的EPEL库.您可以使用以下命令安装它们:yum install epel-release然后,下面这段命令:yum in ...

  2. 如何在 Linux 中配置基于密钥认证的 SSH

    什么是基于 SSH 密钥的认证? 众所周知,Secure Shell,又称 SSH,是允许你通过无安全网络(例如 Internet)和远程系统之间安全访问/通信的加密网络协议.无论何时使用 SSH 在 ...

  3. 如何在Loadrunner11中解决HTTP BASIC认证登录报401的问题

    在对Carte+kettle的性能测试过程中,通过在loadrunner中用web_set_user("cluster", "cluster","17 ...

  4. 如何在Eclipse中查看Java类库的源代码以及相应的api

    你的JDK安装目录下%Java_home%/src.zip文件就是源码,解压缩找到对应包下面的类即可. 如果是Eclipse开发,ctr+鼠标左击,出现不了源码的话,在弹出的视图中点击attach s ...

  5. 基于Node的PetShop,oauth2认证RESTful API

    前篇 - 基本认证,用户名密码 后篇 - OAuth2 认证 前文使用包passport实现了一个简单的用户名.密码认证.本文改用oauth2来实现更加安全的认证.全部代码在这里. OAUTH2 用户 ...

  6. 如何在Dreamweaver中使用emmet

    by zhangxinxu from http://www.zhangxinxu.com本文地址:http://www.zhangxinxu.com/wordpress/?p=3666 一.emmet ...

  7. 新浪微博的OAuth2认证过程

    1. 创建应用 在weibo.com上申请一个应用,获取app key和app secret, 填写redirect uri 2. 获取code 通过在浏览器访问 https://api.weibo. ...

  8. 如何在markdown中打出上标、下标和一些特殊符号

    转自:https://www.jianshu.com/p/80ac23666a98 如何在markdown中打出上标.下标和一些特殊符号 这是朕的江山 关注 2016.08.16 17:07* 字数 ...

  9. Spring Cloud下基于OAUTH2认证授权的实现

    GitHub(spring -boot 2.0.0):https://github.com/bigben0123/uaa-zuul 示例(spring -boot 2.0.0): https://gi ...

  10. OAuth2认证有一定的了解

    转到分享界面后,进行OAuth2认证: 以新浪为例: 第一步.WebView加载界面,传递参数 使用WebView加载登陆网页,通过Get方法传递三个参数:应用的appkey.回调地址和展示方式dis ...

随机推荐

  1. nnUNet相关方法

  2. useSlots-TS

    import {useSlots, VNode} from 'vue'; export const useGetSlots = () => { const slots = useSlots(); ...

  3. MySQL超大表删除数据过程

    背景 笔者在公司负责公司的OpenAPI应用,估产生了调用审计的需求.对于存储这些AccessLog,虽然业界有很合适的架构和理论,奈何我司已成本优先,且作为toB的项目,调用量并不算特别大,每天也就 ...

  4. php7有哪些新特性

    目录 太空船操作符 标量类型声明和返回值的类型说明 null 合并操作符 常量数组 namespace 批量导入 非混合模式的 use 声明 混合模式的 use 声明 复合模式的 use 声明 thr ...

  5. PIL或Pillow学习2

    接着学习下Pillow常用方法: PIL_test1.py : ''' 9, Pillow图像降噪处理 由于成像设备.传输媒介等因素的影响,图像总会或多或少的存在一些不必要的干扰信息,我们将这些干扰信 ...

  6. ActiViz 在 .NET 环境下的 CT 图像渲染

    1. 什么是 ActiViz? ActiViz 是 VTK(Visualization Toolkit) 的 .NET 封装,提供了强大的 3D 计算机图形渲染功能,广泛应用于 医学影像(CT.MRI ...

  7. docker中 启动所有的容器命令

    docker中 启动所有的容器命令 docker start $(docker ps -a | awk '{ print $1}' | tail -n +2) docker中    关闭所有的容器命令 ...

  8. Effective Java理解笔记系列-第1条-何时考虑用静态工厂方法替代构造器?

    为什么写这系列博客? 在阅读<Effective Java>这本书时,我发现有许多地方需要仔细认真地慢慢阅读并且在必要时查阅相关资料才能彻底搞懂,相信有些读者在阅读此书时也有类似感受:同时 ...

  9. Oracle impdp 导入报错 ORA-39083 + ORA-00439

    Oracle 11G R2 impdp导入的时候 一直报错: ORA-39083: 对象类型 TABLE:"xxx"."xxx" 创建失败, 出现错误: ORA ...

  10. udl(Universal Data Link)通用数据连接文件

    新建文本文档 更改后缀名为.udl(注意小点) 然后打开运行 配置并测试 改回后缀名.txt(有个小点哦) 打开就是了