云栈社区»论坛 › 技术文档「 Note & Doc 」 › FastAPI OAuth2安全机制实战：实现用户身份认证与访问令牌 ...

发回帖发新帖

1622 积分	0 好友	232 主题

发消息

FastAPI OAuth2安全机制实战：实现用户身份认证与访问令牌

发表于 3 天前 | 查看: 7| 回复: 0

在 Python Web开发中，API接口的安全性至关重要。FastAPI提供了一套强大且易于使用的安全工具，帮助开发者快速集成认证与授权机制。其内置支持符合OAuth2规范的流程，能够高效处理令牌（Token）验证。

理解OAuth2与FastAPI安全基础

OAuth2是一个定义了多种处理身份认证和授权方法的行业规范。它涵盖了复杂的使用场景，特别是支持使用第三方服务（如Google、GitHub）进行登录。在FastAPI框架中，我们可以利用其fastapi.security模块快速构建基于令牌的安全系统。

快速起步：集成OAuth2PasswordBearer

让我们开始一个简单的实战。首先，我们需要创建一个FastAPI应用并设置一个令牌端点。下面的代码展示了如何初始化一个应用，并为其添加一个需要令牌认证的路径操作：

# -*- coding:utf-8 –*-
from fastapi import FastAPI, Depends
import uvicorn
from fastapi.security import OAuth2PasswordBearer
from typing import Annotated

# 声明一个OAuth2密码承载方案，并指定获取令牌的URL路径
oauth2_scheme = OAuth2PasswordBearer(tokenUrl="token")

app = FastAPI(
    title="后端接口文档",
    description="关于API文档的补充说明",
    version="1.0.0",
    docs_url="/docs"
)

@app.get("/items/")
async def read_items(token: Annotated[str, Depends(oauth2_scheme)]):
    return {"token": token}

if __name__ == '__main__':
    uvicorn.run("main:app", port=8085, reload=True)

此处的OAuth2PasswordBearer是FastAPI提供的一个类，它用于定义如何从请求中提取令牌（通常来自Authorization请求头）。Depends(oauth2_scheme)作为路径操作的依赖项，会自动执行令牌的提取与验证逻辑。

进阶：创建用户模型与获取当前用户

实际应用中，我们不仅需要验证令牌，还需要根据令牌识别具体的用户。为此，我们先定义一个Pydantic模型来描述用户，然后创建一个模拟解码令牌并返回用户对象的依赖函数。

# -*- coding:utf-8 –*-
import uvicorn
from fastapi import Depends, FastAPI
from fastapi.security import OAuth2PasswordBearer
from typing import Annotated
from pydantic import BaseModel

oauth2_scheme = OAuth2PasswordBearer(tokenUrl="token")

class User(BaseModel):
    username: str
    email: str | None = None
    full_name: str | None = None
    disabled: bool | None = None

def fake_decode_token(token):
    # 这是一个模拟解码函数，实际应用中应替换为JWT解码或数据库查询
    return User(
        username=token + "fakedecoded",
        email="rebort@example.com",
        full_name="rebort chen"
    )

async def get_current_user(token: Annotated[str, Depends(oauth2_scheme)]):
    user = fake_decode_token(token)
    return user

app = FastAPI(
    title="后端接口文档",
    description="关于API文档的补充说明",
    version="1.0.0",
    docs_url="/docs"
)

@app.get("/users/me")
async def read_users_me(current_user: Annotated[User, Depends(get_current_user)]):
    return current_user

@app.get("/items/")
async def read_items(token: Annotated[str, Depends(oauth2_scheme)]):
    return {"token": token}

if __name__ == '__main__':
    uvicorn.run("main:app", port=8085, reload=True)

在这个版本中，get_current_user函数成为了一个新的依赖项，它内部依赖于oauth2_scheme来获取令牌，然后通过fake_decode_token函数将令牌“转换”为一个用户对象。这样，路径操作/users/me就能直接获取到当前已验证的用户信息。