title: FastAPI访问令牌的权限声明与作用域管理:你的API安全真的无懈可击吗?

date: 2025/06/15 06:32:07

updated: 2025/06/15 06:32:07

author: cmdragon

excerpt:

FastAPI中,权限声明通过JWT令牌的scopes字段定义用户访问资源范围,如read、write、admin。使用OAuth2PasswordBearer配置令牌获取方式和作用域说明,jwt进行令牌编解码。通过依赖注入实现权限验证,确保用户访问特定端点时具备相应权限。常见错误包括422(缺少Authorization字段)和401(无效凭证),建议使用RSA非对称加密并定期轮换密钥。生产环境中,作用域管理可扩展至多租户系统和功能权限开关。

categories:

  • 后端开发
  • FastAPI

tags:

  • FastAPI
  • 访问令牌
  • 权限声明
  • 作用域管理
  • JWT
  • 依赖注入
  • API安全


扫描二维码

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

发现1000+提升效率与开发的AI工具和实用程序https://tools.cmdragon.cn/

第一章 FastAPI访问令牌的权限声明与作用域管理

1.1 权限声明的核心作用

在API安全体系中,权限声明(Claims)如同身份证上的信息,用于声明用户的访问权限。JWT令牌中的scopes

字段是最典型的权限声明,它定义了用户可以访问的资源范围(如read、write、admin)。

from pydantic import BaseModel
from fastapi import Depends, FastAPI, Security
from fastapi.security import OAuth2PasswordBearer
from jose import JWTError, jwt # 配置OAuth2方案
oauth2_scheme = OAuth2PasswordBearer(
tokenUrl="token",
scopes={
"read": "查看数据权限",
"write": "修改数据权限",
"admin": "管理员权限"
}
) # 用户模型
class User(BaseModel):
username: str
scopes: list[str] = []

1.2 作用域管理的实现逻辑

作用域管理可以通过依赖注入系统实现权限验证层级结构:

# 权限验证依赖项
async def check_permissions(required_scope: str, token: str = Depends(oauth2_scheme)):
try:
payload = jwt.decode(token, "SECRET_KEY", algorithms=["HS256"])
user_scopes = payload.get("scopes", []) # 使用集合判断作用域包含关系
if required_scope not in user_scopes:
raise HTTPException(
status_code=403,
detail="权限不足"
)
return payload
except JWTError:
raise HTTPException(
status_code=401,
detail="无效凭证"
)

1.3 完整API案例实现

实现一个用户管理系统API,包含三种访问级别:

app = FastAPI()

@app.post("/token")
async def login():
# 实际项目应从数据库验证用户
return {
"access_token": jwt.encode(
{"scopes": ["read", "write"]},
"SECRET_KEY",
algorithm="HS256"
),
"token_type": "bearer"
} @app.get("/users/me")
async def read_user_me(
current_user: dict = Depends(check_permissions("read"))
):
return {"user": current_user} @app.post("/users")
async def create_user(
current_user: dict = Depends(check_permissions("write"))
):
return {"status": "用户创建成功"} @app.delete("/users/{user_id}")
async def delete_user(
user_id: int,
current_user: dict = Depends(check_permissions("admin"))
):
return {"status": "用户已删除"}

系统组件说明:

  1. OAuth2PasswordBearer:配置API的令牌获取方式和作用域说明
  2. jwt:使用HS256算法进行令牌编解码
  3. check_permissions:通过依赖注入实现权限验证复用

1.4 课后Quiz

Q1:当用户令牌包含["read", "write"]作用域时,可以访问哪些端点?

A) 仅/users/me

B) /users/me 和 /users

C) 所有端点

D) 仅/users

答案解析

正确答案:B

read作用域允许访问/users/me端点,write作用域允许访问POST /users端点,但delete操作需要admin权限。

Q2:返回403 Forbidden的可能原因是什么?

A) 请求头缺少Authorization

B) 令牌作用域不满足要求

C) 数据库连接失败

D) 请求体格式错误

答案解析

正确答案:B

401错误对应认证失败,403表示已认证但权限不足,当令牌缺失必要作用域时触发。

1.5 常见报错解决指南

错误1:422 Unprocessable Entity

{
"detail": [
{
"loc": [
"header",
"authorization"
],
"msg": "field required",
"type": "value_error.missing"
}
]
}

原因分析

请求头缺少Authorization字段或格式错误

解决方案

  1. 检查请求头是否包含Authorization: Bearer <token>
  2. 确认使用Postman等工具时未勾选错误认证方式
  3. 在Swagger UI中点击"Authorize"按钮设置令牌

错误2:401 Unauthorized

{
"detail": "Invalid authentication credentials"
}

原因排查

  1. 令牌过期时间检查
  2. 验证令牌签名密钥是否匹配
  3. 检查令牌算法是否与服务器配置一致

预防建议

# 建议的令牌生成配置
jwt.encode(
{
"sub": "user123",
"scopes": ["read"],
"exp": datetime.utcnow() + timedelta(minutes=30)
},
"YOUR_SECRET_KEY", # 推荐使用RSA256更安全
algorithm="HS256"
)

1.6 部署注意事项

安装所需依赖:

pip install fastapi==0.68.0
pip install pydantic==1.8.2
pip install python-jose==3.3.0
pip install uvicorn==0.15.0

生产环境建议:

  1. 使用RSA非对称加密替代HS256
  2. 作用域名称采用统一命名规范(如resource:action)
  3. 敏感操作开启双重认证
  4. 定期轮换加密密钥

通过以上配置,开发者可以构建出符合OWASP安全标准的API权限控制系统。作用域管理方案不仅适用于用户角色,还可扩展至多租户系统、功能权限开关等复杂场景。

余下文章内容请点击跳转至 个人博客页面 或者 扫码关注或者微信搜一搜:编程智域 前端至全栈交流与成长,阅读完整的文章:FastAPI访问令牌的权限声明与作用域管理:你的API安全真的无懈可击吗? | cmdragon's Blog

往期文章归档:

FastAPI访问令牌的权限声明与作用域管理:你的API安全真的无懈可击吗?的更多相关文章

  1. 掀起Azure AD的盖头来——深入理解Microsoft Graph应用程序和服务权限声明

    作者:陈希章 发表于 2017年7月12日 引子 这是一篇计划外的文章.我们都知道要进行Microsoft Graph的开发的话,需要进行应用程序注册.这个在此前我已经有专门的文章写过了.但这里存在一 ...

  2. Android清单文件具体解释(二) ---- 应用程序权限声明

    我们知道,Android系统的各个模块提供了很强大的功能(比方电话,电源和设置等),通过使用这些功能.应用程序能够表现的更强大.更灵活.只是,使用这些功能并非无条件的.而是须要拥有一些权限.接下来,我 ...

  3. 一:Go编程语言规范--块、声明、作用域

    1.块 块为一对大括号括住的声明和语句.块 = "{" { 语句 ";" } "}" . 除显式源码块外,还有隐式块: 全域块 包含所有的G ...

  4. iOS10权限声明国际化

    iOS 10要求用户声明隐私访问用途,而且不能为空,否则将会被拒.被拒邮件如下: 解决办法是在Info.plist中添加Privacy - Camera Usage Description和Priva ...

  5. JavaEE学习之Spring Security3.x——模拟数据库实现用户,权限,资源的管理

    一.引言 因项目需要最近研究了下Spring Security3.x,并模拟数据库实现用户,权限,资源的管理. 二.准备 1.了解一些Spring MVC相关知识: 2.了解一些AOP相关知识: 3. ...

  6. javascript变量声明及作用域总结

    javascript变量声明及作用域总结 一.总结 一句话总结:还是得好好看书,光看视频是不得行的,浅学无用,要相互印证,要真正理解才有用,比如<Javascript权威指南> 书 1.j ...

  7. BeanFactory 使用控制反转 (IOC) 模式将应用程序的配置和依赖性规范与实际的应用程序代码分开。面向切面 将声明性事务管理集成到应用程序中

    Spring 系列: Spring 框架简介 https://www.ibm.com/developerworks/cn/java/wa-spring1/ Spring 框架简介 Spring AOP ...

  8. 浅谈javascript函数,变量声明及作用域

    javascript函数跟变量的声明.作用域这些概念网上都已经讲烂了. 这里写个博客,也相当于做个笔记. 变量声明 首先看个例子: var globalVar = "gv"; fu ...

  9. Greenplum中角色权限及客户端认证管理

    角色权限及客户端认证管理 GP数据库逻辑结构 在GP中,Database(数据库).Schema(模式)以及Role(角色)三者之间的关系如下所示: 一个数据库下可以有多个模式,一个模式只属于一个数据 ...

  10. Linux用户和权限——用户和用户组管理

    Linux用户和权限——用户和用户组管理 摘要:本文主要介绍了Linux系统中的用户和用户组管理. 用户和用户组 含义 在使用Linux系统时,虽然输入的是自己的用户名和密码,但其实Linux并不认识 ...

随机推荐

  1. VMware ESXi系统

    esxi全称"VMware ESXi",是可直接安装在物理服务器上的强大的裸机管理系统,是一款虚拟软件,不需安装其他操作系统,是VMware服务器虚拟化的基础.通过直接访问并控制底 ...

  2. RMQ 和 LCA 问题

    # Part 1 RMQ RMQ,即区间信息维护问题 如最大值,最小值,GCD 等 RMQ 算法实现很多 具体有线段树,树状数组和 ST 表 但综合时间复杂度最好的是 ST 表 查询 O(1),预处理 ...

  3. 【JDBC第4章】操作BLOB类型字段

    第4章:操作BLOB类型字段 4.1 MySQL BLOB类型 MySQL中,BLOB是一个二进制大型对象,是一个可以存储大量数据的容器,它能容纳不同大小的数据. 插入BLOB类型的数据必须使用Pre ...

  4. 【Java】RESTful风格

    RESTful风格 REST:即 Representational State Transfer.(资源)表现层状态转化.是目前最流行的一种互联网软件架构.它结构清晰.符合标准.易于理解.扩展方便,所 ...

  5. CH182的ESP32驱动

    CH182的ESP32驱动需要自取 https://files.cnblogs.com/files/blogs/745523/esp-eth.zip?t=1739322979&download ...

  6. GIS空间索引技术

    地理信息系统(Geography Information System,简称GIS)的主要任务之一是有效地检索空间数据及快速响应不同用户的在线查询.地理空间索引技术和方法是GIS的关键技术.是快速高效 ...

  7. 如何对 Java 的垃圾回收进行调优?

    如何对 Java 的垃圾回收进行调优? Java 垃圾回收的调优涉及多个方面,从选择合适的垃圾回收器到调整堆内存的大小.配置 GC 参数等,下面是一些常见的调优方法: 1. 选择合适的垃圾回收器 不同 ...

  8. windows 通过cmd使用tail命令

    参考: https://www.jianshu.com/p/743964656bb4

  9. ZYNQ PL端向PS端发出中断

    在之前的项目中知道zynq的PS端可以通过AXI总线向PL端的IP核写入数据,而PL端也可以通过AXI总线去访问PS端的DDR等设备.然而当PL端的IP在接收到PS端的指令完成操作后,该如何告知PS端 ...

  10. Linux 常识和操作(常用命令)

    1. 存放用户账号的文件在哪里? /etc/passwd 2. 如何删除一个非空的目录? rm -rf 目录名 3. 查看当前的工作目录用什么命令? pwd 4. 创建一个文件夹用什么命令? mkdi ...