fastapi_No.21_安全性_目录权限认证

已于 2022-11-05 17:21:14 修改
阅读量1.3k 收藏 5
点赞数 4
分类专栏： # FastAPI 文章标签： fastapi python 后端
于 2022-11-05 16:22:37 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/baidu_38766791/article/details/127700309
版权

文章目录


在实际开发中，每个用户的权限是不同的。通俗的讲就是不同的用户可以访问不同的路径。
在fastapi中主要是通过OAuth2 scopes来实现的。
下面是代码实现过程的示例。

后端实现步骤

第一步：指定登录路径

from fastapi.security import OAuth2PasswordBearer

# 指定登录路径
oauth2_scheme = OAuth2PasswordBearer(
	tokenUrl="token",
    scopes={
        "me":"Read information about the current user",
        'items':'Read items'
    }
)

第二步：创建登录路径及其路径操作函数

from fastapi import FastAPI,Depends
from fastapi.security import OAuth2PasswordRequestForm
from pydantic import BaseModel
from jose import JWSError,jwt
from typing import Union,List
from datetime import datetime,timedelta
from passlib.context import CryptContext

#用于加密的密钥和算法及用户token过期时间
SECRET_KEY = "09d25e094faa6ca2556c818166b7a9563b93f7099f6f0f4caa6cf63b88e8d3e7"
ALGORITHM = "HS256"
ACCESS_TOKEN_EXPIRE_MINUTES = 30

# 定义加密模式
pwd_context = CryptContext(schemes=["bcrypt"],deprecated='auto')

# 定义token回复模型
class Token(BaseModel):
    access_token:str
    token_type:str

# 定义用户数据模型
class User(BaseModel):
    username:str
    email:Union[str,None] = None
    full_name:Union[str,None] = None
    disabled:Union[bool,None] = None

class UserInDB(User):
    hashed_password:str

# 定义根据用户名获取数据库用户信息
def get_user(db,username:str):
    if username in db:
        user_dict = db[username]
        return UserInDB(**user_dict)

# 验证密码及hash密码是否一致
def verify_password(plain_pwd,hashed_pwd):
    return pwd_context.verify(plain_pwd,hashed_pwd)

# 定义认证用户方法
def authenticate_user(db,username:str,password:str):
    user = get_user(db=db,username=username)
    if not user:
        return False
    if not verify_password(password,user.hashed_password):
        return False
    return user

# 定义创建token方法
def create_access_token(data:dict,expires:Union[timedelta,None]=None):
    to_encode = data.copy()
    if expires:
        expire = datetime.now() + expires
    else:
        expire = datetime.now() + timedelta(minutes=15)
    to_encode.update({"exp":expire})
    #生成jwt token
    encoded_jwt = jwt.encode(to_encode,SECRET_KEY,algorithm=ALGORITHM)
    return encoded_jwt
    
# 创建FastAPI实例对象
app = FastAPI()

# 定义/token路径装饰器及路径操作函数
@app.post("/token",response_model=Token)
async def login_for_access_token(form_data:OAuth2PasswordRequestForm=Depends()):
    user = authenticate_user(fake_users_db,form_data.username,form_data.password)
    if not user:
        raise HTTPException(status_code=400,detail="Incorrent username or password")
    access_token_expires = timedelta(minutes=ACCESS_TOKEN_EXPIRE_MINUTES)
    access_token = create_access_token(
    	# 此处是为了模拟路径权限，直接在form表单中传入了用户的路径权限scopes
    	# 实际应用中应根据用户信息，从数据库中获取scopes
        data={"sub":user.username,"scopes":form_data.scopes},
        expires=access_token_expires
    )
    return {"access_token":access_token,"token_type":"bearer"}

第三步：创建根据token获取用户及其权限信息

# 引入SecurityScopes
from fastapi.security import SecurityScopes
from fastapi import HTTPException,status

fake_users_db = {
    "johndoe": {
        "username": "johndoe",
        "full_name": "John Doe",
        "email": "johndoe@example.com",
        "hashed_password": "$2b$12$EixZaYVK1fsbw1ZfbX3OXePaWxn96p36WQoeG6Lruj3vjPGga31lW",
        "disabled": False,
    },
    "alice": {
        "username": "alice",
        "full_name": "Alice Chains",
        "email": "alicechains@example.com",
        "hashed_password": "$2b$12$gSvqqUPvlXP2tfVFaWK1Be7DlH.PKZbv5H8KnzzVgXXbVxpva.pFm",
        "disabled": True,
    },
}

# 定义token数据模型
class TokenData(BaseModel):
    username:Union[str,None] = None
    scopes:List[str] = []

# 定义根据token获取用户信息及路径权限的方法
# 这里的security_scopes表示用户访问时需要的权限名称
async def get_current_user(
    security_scopes:SecurityScopes,token:str=Depends(oauth2_scheme)
):
    # 获取scopes
    if security_scopes.scopes:
        authenticate_value = f'Bearer scope="{security_scopes.scope_str}"'
    else:
        authenticate_value = f"Bearer"
    # 定义认证失败的报错
    credentials_exception = HTTPException(
        status_code=status.HTTP_401_UNAUTHORIZED,
        detail='Could not validate credentials',
        headers={"WWW-Authenticate":authenticate_value}
    )
    try:
        # jwt解密token
        playload = jwt.decode(token,SECRET_KEY,algorithms=ALGORITHM)
        username = playload.get("sub")
        if username is None:
            raise credentials_exception
        token_scopes = playload.get("scopes",[])
        token_data = TokenData(username=username,scopes=token_scopes)
    except(JWSError,ValidationError):
        raise credentials_exception
    user = get_user(db=fake_users_db,username=token_data.username)
    if user is None:
        raise credentials_exception
    for scope in security_scopes.scopes:
        if scope not in token_data.scopes:
            raise HTTPException(
                status_code=status.HTTP_401_UNAUTHORIZED,
                detail="Not enough permissions",
                headers={"WWW-Authenticate":authenticate_value}
            )
    return user

# 从fastapi中引入Security
# Security是Depends的子类，具有scopes属性，并将scopes属性传入依赖项中，表示访问的路径
from fastapi import Security
# 验证用户是否处于激活状态
async def get_current_active_user(
    current_user:User = Security(get_current_user,scopes=['me'])
):
    if current_user.disabled:
        raise HTTPException(status_code=400,detail="Inactive user")
    return current_user

第四步：路径修饰器及路径操作函数

@app.get("/users/me",response_model=User)
async def read_users_me(current_user:User=Depends(get_current_active_user)):
    return current_user

@app.get("/users/me/items/")
async def read_own_items(
    current_user: User = Security(get_current_active_user, scopes=["items"])
):
    return [{"item_id": "Foo", "owner": current_user.username}]

@app.get("/status/")
async def read_system_status(current_user: User = Depends(get_current_user)):
    return {"status": "ok"}

第五步：运行服务器

if __name__ == '__main__':
    import uvicorn
    uvicorn.run(app='test:app',host='127.0.0.1',port=8080,reload=True)

完整后端代码

# oauth2 区域认证用来给用户或app特定的权限。
# oauth2中的区域可以理解为string类型的列表，且列表中每个string不能包含空格

from datetime import datetime,timedelta
from typing import List,Union

from fastapi import Depends,FastAPI,HTTPException,Security,status
from fastapi.security import OAuth2PasswordBearer,OAuth2PasswordRequestForm,SecurityScopes

from jose import JWSError,jwt
from passlib.context import CryptContext
from pydantic import BaseModel,ValidationError


#用于加密的密钥和算法及用户token过期时间
SECRET_KEY = "09d25e094faa6ca2556c818166b7a9563b93f7099f6f0f4caa6cf63b88e8d3e7"
ALGORITHM = "HS256"
ACCESS_TOKEN_EXPIRE_MINUTES = 30

# 模拟数据库中存储的用户数据
fake_users_db = {
    "johndoe": {
        "username": "johndoe",
        "full_name": "John Doe",
        "email": "johndoe@example.com",
        "hashed_password": "$2b$12$EixZaYVK1fsbw1ZfbX3OXePaWxn96p36WQoeG6Lruj3vjPGga31lW",
        "disabled": False,
    },
    "alice": {
        "username": "alice",
        "full_name": "Alice Chains",
        "email": "alicechains@example.com",
        "hashed_password": "$2b$12$gSvqqUPvlXP2tfVFaWK1Be7DlH.PKZbv5H8KnzzVgXXbVxpva.pFm",
        "disabled": True,
    },
}

# 创建token返回数据模型
class Token(BaseModel):
    access_token:str
    token_type:str

# 创建token解析数据模型
class TokenData(BaseModel):
    username:Union[str,None] = None
    scopes:List[str] = []

# 创建用户数据模型
class User(BaseModel):
    username:str
    email:Union[str,None] = None
    full_name:Union[str,None] = None
    disabled:Union[bool,None] = None

class UserInDB(User):
    hashed_password:str

# 定义加密模式
pwd_context = CryptContext(schemes=["bcrypt"],deprecated='auto')

# 定义登录地址及用户权限。
# 此处设定scopes主要作用是用在docs中显示可选的几个scope，实际开发中可以不添加
oauth2_scheme = OAuth2PasswordBearer(
    tokenUrl="token",
    scopes={
        "me":"Read information about the current user",
        'items':'Read items'
    }
)

app = FastAPI()

# 验证密码是否正确
def verify_password(plain_pwd,hashed_pwd):
    return pwd_context.verify(plain_pwd,hashed_pwd)

# 生成加密的密码
def get_hashed_password(password):
    return pwd_context.hash(password)

# 根据用户名在数据库中获取用户信息
def get_user(db,username:str):
    if username in db:
        user_dict = db[username]
        return UserInDB(**user_dict)

# 用户登录认证，验证用户名是否存在，密码是否正确
def authenticate_user(db,username:str,password:str):
    user = get_user(db=db,username=username)
    if not user:
        return False
    if not verify_password(password,user.hashed_password):
        return False
    return user

# 创建token信息
def create_access_token(data:dict,expires:Union[timedelta,None]=None):
    to_encode = data.copy()
    if expires:
        expire = datetime.now() + expires
    else:
        expire = datetime.now() + timedelta(minutes=15)
    to_encode.update({"exp":expire})
    #生成jwt token
    encoded_jwt = jwt.encode(to_encode,SECRET_KEY,algorithm=ALGORITHM)
    return encoded_jwt

# 解析token，获取用户相关信息（user,scopes等，根据定义来获得)
# security_scopes表示被访问的路径所需的权限
async def get_current_user(
    security_scopes:SecurityScopes,token:str=Depends(oauth2_scheme)
):
    # 获取scopes
    if security_scopes.scopes:
        authenticate_value = f'Bearer scope="{security_scopes.scope_str}"'
    else:
        authenticate_value = f"Bearer"
    # 定义认证失败的报错
    credentials_exception = HTTPException(
        status_code=status.HTTP_401_UNAUTHORIZED,
        detail='Could not validate credentials',
        headers={"WWW-Authenticate":authenticate_value}
    )
    try:
        # jwt解密token
        playload = jwt.decode(token,SECRET_KEY,algorithms=ALGORITHM)
        # 获取token中的用户名信息，sub是根据后面的/token路径操作函数中定义得来
        username = playload.get("sub")
        if username is None:
            raise credentials_exception
        # 获取token中的scopes信息，scopes是根据后面的/token路径操作函数中定义得来
        token_scopes = playload.get("scopes",[])
        token_data = TokenData(username=username,scopes=token_scopes)
    except(JWSError,ValidationError):
        raise credentials_exception
    user = get_user(db=fake_users_db,username=token_data.username)
    if user is None:
        raise credentials_exception
    # 检查该路径访问所需的权限名称，在该用户token包含的scopes中是否都具有，否则报错
    for scope in security_scopes.scopes:
        if scope not in token_data.scopes:
            raise HTTPException(
                status_code=status.HTTP_401_UNAUTHORIZED,
                detail="Not enough permissions",
                headers={"WWW-Authenticate":authenticate_value}
            )
    return user

# 定义获取当前激活用户的依赖函数
async def get_current_active_user(
    # Security是Depends的子类，用来表示该路径所需的权限名称
    current_user:User = Security(get_current_user,scopes=['me'])
):
    if current_user.disabled:
        raise HTTPException(status_code=400,detail="Inactive user")
    return current_user

# 定义登录接口,返回用户的token
@app.post("/token",response_model=Token)
async def login_for_access_token(form_data:OAuth2PasswordRequestForm=Depends()):
    user = authenticate_user(fake_users_db,form_data.username,form_data.password)
    if not user:
        raise HTTPException(status_code=400,detail="Incorrent username or password")
    access_token_expires = timedelta(minutes=ACCESS_TOKEN_EXPIRE_MINUTES)
    access_token = create_access_token(
        data={"sub":user.username,"scopes":form_data.scopes},
        expires=access_token_expires
    )
    return {"access_token":access_token,"token_type":"bearer"}

# 定义需要me权限的访问路径
@app.get("/users/me",response_model=User)
async def read_users_me(current_user:User=Depends(get_current_active_user)):
    return current_user

# 定义需要me和items权限的访问路径
@app.get("/users/me/items/")
async def read_own_items(
    current_user: User = Security(get_current_active_user, scopes=["items"])
):
    return [{"item_id": "Foo", "owner": current_user.username}]

# 定义需要用户登录的访问路径
@app.get("/status/")
async def read_system_status(current_user: User = Depends(get_current_user)):
    return {"status": "ok"}

if __name__ == '__main__':
    import uvicorn
    uvicorn.run(app='oath2:app',host='127.0.0.1',port=8080,reload=True)

前端验证

登录

登录界面username，password，scope是OAuth2PasswordRequestForm中限定的，必须用对应的名称。
scope表示该用户拥有的权限名称，存在多个时，用空格分开。
此处限定该用户有访问me权限。
在这里插入图片描述

访问me权限路径

利用登录中获得的token信息，输入认证中心。
可以获得响应的响应结果。
在这里插入图片描述

访问items权限路径

由于该用户没有items权限，所以显示没有权限访问。
在这里插入图片描述

访问无权限限制路径

由于status路径没有权限设定，故该用户可以访问成功。
在这里插入图片描述

爱学习_程序员
关注
  • 4
    点赞
  • 踩
  • 5
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 0
    评论
专栏目录
fast-api-permission:快速API权限
03-25
快速API权限 快速API权限
探索FastAPI权限管理新星：fastapi-permissions
gitblog_00013的博客
04-20 626
探索FastAPI权限管理新星：fastapi-permissions 项目地址:https://gitcode.com/holgi/fastapi-permissions 项目简介 fastapi-permissions 是一个基于 FastAPI 的强大权限管理系统，旨在简化Web应用的安全性配置。它通过声明式的方法帮助开发者在FastAPI应用中轻松实现复杂的访问控制逻辑。 技术分析 ...
FastAPI完全指南：实现高效、安全的Web开发
最新发布
Innocence_0的博客
05-26 942
在快速发展的互联网时代，高效的Web开发变得尤为重要。Python作为一门广受欢迎的编程语言，其众多Web框架中，FastAPI凭借其出色的性能和易用性，成为了一个炙手可热的选择。FastAPI是一个用于构建API的现代、高性能的Web框架，它基于Python3.6+的类型提示，提供了快速、直观且易于学习的API开发体验。响应类型FastAPI允许你定义多种响应类型，包括JSON、HTML、纯文本等。return “文档定制FastAPI允许你自定义这些文档的一些方面，如标题、描述和版本号。
react+fastapi前后端分离OAuth2权限验证的用户登陆案例
10-30
User-OAuth2-Login是react+fastapi前后端分离OAuth2权限验证的用户登陆案例.后端采用fastapi创建的OpenAPI接口,后端通过OAuth2的token来验证前端的登陆请求.前端采用React+Material UI布局,通过Axios访问接口获得数据和权限验证.
FastAPI通用权限管理系统
一米阳光的博客
07-16 995
一款 Python 语言基于FastAPI、Layui、MySQL等框架精心打造的一款模块化、高性能、企业级的敏捷开发框架，本着简化开发、提升开发效率的初衷触发，框架自研了一套个性化的组件，实现了可插拔的组件式开发方式：单图上传、多图上传、下拉选择、开关按钮、单选按钮、多选按钮、图片裁剪等等一系列个性化、轻量级的组件，是一款真正意义上实现组件化开发的敏捷开发框架。
fastapi权限控制
小生测试的博客
08-26 1256
不过fastapi 的权限控制，他要在请求头header上"Authorization":“Bearer 你的token”.OAuth2PasswordBearer会自动解析请求头这个参数的内容，解析不到就报权限失败。将get_current_user参数换成request: Request，这样就能控制我们只传入token就好了。这个用法是写死固定的。使用fastapi原生自带的AUTH_SCHEMA 作为权限控制。所以我们就放弃原生的fastapi权限设置，用自己的权限控制。
Python FastAPI框架实现一个基本的用户登录接口，并添加权限功能
weixin_45319250的博客
03-22 3156
Python FastAPI框架实现一个基本的用户登录接口，并添加权限功能
FastAPI+Layui后台权限管理系统
一米阳光的博客
07-20 204
一款 Python 语言基于FastAPI、Layui、MySQL等框架精心打造的一款模块化、高性能、企业级的敏捷开发框架，本着简化开发、提升开发效率的初衷触发，框架自研了一套个性化的组件，实现了可插拔的组件式开发方式：单图上传、多图上传、下拉选择、开关按钮、单选按钮、多选按钮、图片裁剪等等一系列个性化、轻量级的组件，是一款真正意义上实现组件化开发的敏捷开发框架。
fastapi_cache:简单缓存FastAPI
05-06
FastAPI缓存 将简单的轻量级缓存系统实现为FastAPI中的依赖项。 安装 pip install fastapi-cache 用法示例 from fastapi import Depends , FastAPI from fastapi_cache import caches , close_caches from fastapi_...
fastapi_contrib：在FastAPI之上有目的的实用程序集
02-03
总结起来，fastapi_contrib是FastAPI生态中的一个重要补充，它提升了FastAPI的实用性，使得开发者能够更加高效地构建功能完备、高性能的API服务。无论是在数据处理、接口验证还是在项目初始化阶段，fastapi_contrib...
fastapi_login:FastAPI登录尝试提供与Flask-Login相似的功能
05-14
FastAPI登录 FastAPI登录试图提供与相似的功能。 文献资料 可以在找到深入的文档。在可以找到一些示例。 安装 $ pip install fastapi-login 用法 首先，我们必须设置我们的FastAPI应用程序： from fastapi import ...
cjh_fastapi_base.zip
03-24
《基于FastAPI的高效开发框架——cjh_fastapi_base》 FastAPI是一个现代、高性能的Web框架，用于构建APIs，其设计灵感来源于Starlette和Pydantic。它以其简洁的代码风格、强大的类型注解支持和出色的性能，赢得了...
FastAPI_EN_DOC.pdf
02-20
FastAPI is a modern, fast (high-performance), web framework for building APIs with Python 3.6+ based on standard Python type hints.
Django+Vue+ElementUI管理后台源码
一米阳光的博客
03-15 924
一款 Python 语言基于Django、Vue2.x、ElementUI、MySQL等框架精心打造的一款模块化、高性能、企业级的敏捷开发框架，本着简化开发、提升开发效率的初衷触发，框架自研了一套个性化的组件，实现了可插拔的组件式开发方式：单图上传、多图上传、下拉选择、开关按钮、单选按钮、多选按钮等等一系列个性化、轻量级的组件，是一款真正意义上实现低代码开发的敏捷开发框架。
fastapi身份认证
fggdgh的博客
12-10 2671
fastapi OAuth2用户认证
FastAPI+Vue权限管理系统
一米阳光的博客
07-27 261
一款 Python 语言基于FastAPI、Vue、ElementUI、MySQL等框架精心打造的一款模块化、高性能、企业级的敏捷开发框架，本着简化开发、提升开发效率的初衷触发，框架自研了一套个性化的组件，实现了可插拔的组件式开发方式：单图上传、多图上传等一系列个性化、轻量级的组件，是一款真正意义上实现组件化开发的敏捷开发框架。
fastapi用户权限模块——“获取用户信息“
m0_52073444的博客
12-17 350
这段代码是一个使用FastAPI框架编写的Python后端API接口。它使用了GET请求方法，路径为"/user/{user_id}"，用于获取特定用户的信息。在函数内部，它依赖一个数据库会话（db）和一个名为"u"的用户对象（Users），并且需要满足"perm:user:get"和"perm:user:put"这两个权限才能访问。最后，它会调用curd_user.get(db, user_id)来获取用户信息，并将结果以JSON格式返回。
【Python开发】FastAPI 08：Security 登录认证
尹煜的博客
06-04 4560
FastAPI提供了多种工具，可帮助你以标准的方式轻松、快速地处理安全性，而无需研究和学习所有的安全规范，这相比花费大量的精力和代码处理安全性和身份认证很有好了（比如java😂）。
FastAPI入门
m0_70618214的博客
08-13 1255
什么是 FastAPI 呢？ FastAPI 是 Python 的一个框架，如果要类比的话，那就是： Nodejs 和 Nestjs Java 和 Spring Php 和 ThinkPhp
FastAPI_Login实现用户登录认证
04-26
好的，你的第一个问题是关于如何实现用户登录认证。 FastAPI 提供了一些简单易用的库来处理认证，其中最常用的是 FastAPI_Login 库。该库使用 JWT（JSON Web Tokens）实现了基于 Token 的身份验证和访问控制。您可以在用户成功登录后使用该库来生成一个包含用户身份信息的 JWT，并将其返回给客户端。之后，客户端可以在每个请求中将 JWT 作为头部或请求参数发送到您的服务器。 FastAPI_Login 库将检查 JWT 的有效性，并根据您的配置来授权或拒绝请求。这就是一个基本的用户登录认证的实现方式。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

爱学习_程序员

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值