Files
ctms/backend/app/core/decorators.py
T
Cheng Zhou 0cc87210af 权限系统:完成接口级权限系统第6阶段(测试与文档)
## 主要完成内容

### 1. 接口级权限系统实现
- 新增 ApiEndpointPermission 模型:存储接口级权限配置
- 新增 ApiEndpointRegistry 模型:注册系统中所有API端点
- 实现权限检查优先级:接口级 > 模块级(向后兼容)
- 支持细粒度权限控制(METHOD:/path 格式)

### 2. 权限配置系统
- 创建 api_permissions.py:集中管理接口权限配置
- 定义 API_ENDPOINT_PERMISSIONS:所有端点的权限映射
- 定义 MODULE_TO_ENDPOINTS:模块到接口的映射(向后兼容)
- 支持默认角色配置和权限继承

### 3. 权限检查依赖注入
- 新增 require_api_permission():基于接口的权限检查
- 新增 @register_api_endpoint 装饰器:端点元数据注册
- 集成 FastAPI 依赖注入系统
- 支持权限拒绝时返回 403 Forbidden

### 4. API端点迁移(第1批)
- 迁移 subjects 模块:5个端点
- 迁移 risk_issues 模块:3个端点
- 迁移 fees 模块:8个端点
- 迁移 finance_contracts 模块:5个端点
- 共计 21 个端点完成迁移

### 5. 权限管理API
- GET /studies/{study_id}/api-permissions:获取权限矩阵
- PUT /studies/{study_id}/api-permissions:更新权限矩阵
- 支持权限配置的查询和修改

### 6. 测试与验证
- 单元测试:12 个测试用例,全部通过
- 集成测试:11 个权限管理API测试,全部通过
- 端点测试:22 个已迁移端点测试,全部通过
- 代码覆盖率:87%(超过 80% 目标)
- 总计:45 个测试用例,全部通过

### 7. 文档
- TESTING_SUMMARY.md:详细的测试结果总结
- IMPLEMENTATION_SUMMARY.md:实现细节文档
- TESTING_GUIDE.md:测试指南

## 技术亮点

1. **向后兼容性**:保留模块级权限,接口级权限优先
2. **灵活的权限配置**:支持默认角色和自定义权限
3. **细粒度控制**:支持跨模块数据访问权限
4. **完整的测试覆盖**:单元测试、集成测试、端点测试
5. **清晰的权限检查流程**:接口级 → 模块级 → 拒绝

## 下一步工作

- [ ] 第7阶段:迁移第2批模块(members, sites)
- [ ] 第8阶段:迁移第3批模块
- [ ] 第9阶段:安全审计
- [ ] 第10阶段:性能测试
- [ ] 第11阶段:文档更新

Co-Authored-By: Claude Haiku 4.5 <noreply@anthropic.com>
2026-05-13 15:18:02 +08:00

120 lines
3.7 KiB
Python

"""API端点权限装饰器和初始化函数"""
from __future__ import annotations
from functools import wraps
from typing import Callable, Any
import uuid
from sqlalchemy.ext.asyncio import AsyncSession
from sqlalchemy import select
from app.models.api_endpoint_registry import ApiEndpointRegistry
from app.core.api_permissions import API_ENDPOINT_PERMISSIONS
def register_api_endpoint(
endpoint_key: str,
module: str,
action: str,
description: str = "",
default_roles: list[str] | None = None,
):
"""装饰器:注册API端点权限
在函数上附加元数据,用于系统初始化时自动注册端点。
参数:
endpoint_key: 接口标识,格式为 "METHOD:/path"
module: 关联的模块,用于向后兼容
action: 操作类型,"read" 或 "write"
description: 接口描述
default_roles: 默认允许的角色列表
"""
def decorator(func: Callable) -> Callable:
func._endpoint_key = endpoint_key
func._module = module
func._action = action
func._description = description
func._default_roles = default_roles or []
return func
return decorator
async def initialize_api_endpoint_registry(db: AsyncSession) -> None:
"""初始化API端点注册表
扫描所有已定义的API端点配置,将其写入数据库。
如果端点已存在,则跳过;否则创建新记录。
"""
for endpoint_key, config in API_ENDPOINT_PERMISSIONS.items():
# 检查端点是否已存在
result = await db.execute(
select(ApiEndpointRegistry).where(
ApiEndpointRegistry.endpoint_key == endpoint_key,
)
)
existing = result.scalar_one_or_none()
if existing:
continue
# 创建新的端点注册记录
registry = ApiEndpointRegistry(
id=uuid.uuid4(),
endpoint_key=endpoint_key,
method=endpoint_key.split(":")[0],
path=endpoint_key.split(":", 1)[1],
module=config["module"],
action=config["action"],
description=config.get("description", ""),
default_roles=",".join(config.get("default_roles", [])),
)
db.add(registry)
await db.commit()
async def initialize_project_api_permissions(
db: AsyncSession,
study_id: uuid.UUID,
) -> None:
"""为新项目初始化默认的接口级权限
根据API端点的默认角色配置,为项目创建初始权限记录。
"""
from app.models.api_endpoint_permission import ApiEndpointPermission
# 获取所有已注册的端点
result = await db.execute(select(ApiEndpointRegistry))
endpoints = result.scalars().all()
# 为每个端点和默认角色创建权限记录
for endpoint in endpoints:
default_roles = endpoint.default_roles.split(",") if endpoint.default_roles else []
for role in default_roles:
if not role or role == "ADMIN":
continue
# 检查权限是否已存在
perm_result = await db.execute(
select(ApiEndpointPermission).where(
ApiEndpointPermission.study_id == study_id,
ApiEndpointPermission.role == role,
ApiEndpointPermission.endpoint_key == endpoint.endpoint_key,
)
)
if perm_result.scalar_one_or_none():
continue
# 创建新的权限记录
permission = ApiEndpointPermission(
id=uuid.uuid4(),
study_id=study_id,
role=role,
endpoint_key=endpoint.endpoint_key,
allowed=True,
)
db.add(permission)
await db.commit()