权限系统:完成接口级权限系统第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>
This commit is contained in:
Cheng Zhou
2026-05-13 15:18:02 +08:00
parent a17f4cc522
commit 0cc87210af
59 changed files with 3368 additions and 230 deletions
+291
View File
@@ -0,0 +1,291 @@
"""接口级权限配置
定义系统中所有API端点的权限配置,支持细粒度的接口级权限控制。
"""
from __future__ import annotations
# 接口级权限配置
# 格式: "METHOD:/path": {配置信息}
API_ENDPOINT_PERMISSIONS = {
# 参与者管理 (subjects)
"POST:/subjects": {
"module": "subjects",
"action": "write",
"description": "创建参与者",
"default_roles": ["PM", "CRA"],
},
"GET:/subjects": {
"module": "subjects",
"action": "read",
"description": "查询参与者列表",
"default_roles": ["PM", "CRA", "PV", "MEDICAL_REVIEW", "IMP", "QA"],
},
"GET:/subjects/{id}": {
"module": "subjects",
"action": "read",
"description": "查询参与者详情",
"default_roles": ["PM", "CRA", "PV", "MEDICAL_REVIEW", "IMP", "QA"],
},
"PATCH:/subjects/{id}": {
"module": "subjects",
"action": "write",
"description": "更新参与者",
"default_roles": ["PM", "CRA"],
},
"DELETE:/subjects/{id}": {
"module": "subjects",
"action": "write",
"description": "删除参与者",
"default_roles": ["PM"],
},
# 访视管理 (visits)
"POST:/subjects/{subject_id}/visits": {
"module": "subjects",
"action": "write",
"description": "创建访视",
"default_roles": ["PM", "CRA"],
},
"GET:/subjects/{subject_id}/visits": {
"module": "subjects",
"action": "read",
"description": "查询访视列表",
"default_roles": ["PM", "CRA", "PV", "MEDICAL_REVIEW", "IMP", "QA"],
},
"GET:/subjects/{subject_id}/visits/{visit_id}": {
"module": "subjects",
"action": "read",
"description": "查询访视详情",
"default_roles": ["PM", "CRA", "PV", "MEDICAL_REVIEW", "IMP", "QA"],
},
"PATCH:/subjects/{subject_id}/visits/{visit_id}": {
"module": "subjects",
"action": "write",
"description": "更新访视",
"default_roles": ["PM", "CRA"],
},
# 不良事件 (SAE)
"POST:/risk-issues": {
"module": "risk_issues",
"action": "write",
"description": "创建不良事件",
"default_roles": ["PM", "CRA", "PV", "MEDICAL_REVIEW"],
},
"GET:/risk-issues": {
"module": "risk_issues",
"action": "read",
"description": "查询不良事件列表",
"default_roles": ["PM", "CRA", "PV", "MEDICAL_REVIEW", "IMP", "QA"],
},
"GET:/risk-issues/{id}": {
"module": "risk_issues",
"action": "read",
"description": "查询不良事件详情",
"default_roles": ["PM", "CRA", "PV", "MEDICAL_REVIEW", "IMP", "QA"],
},
"PATCH:/risk-issues/{id}": {
"module": "risk_issues",
"action": "write",
"description": "更新不良事件",
"default_roles": ["PM", "CRA", "PV", "MEDICAL_REVIEW"],
},
"DELETE:/risk-issues/{id}": {
"module": "risk_issues",
"action": "write",
"description": "删除不良事件",
"default_roles": ["PM"],
},
# 财务合同管理 (finance_contracts)
"POST:/finance/contracts": {
"module": "fees",
"action": "write",
"description": "创建财务合同",
"default_roles": ["PM"],
},
"GET:/finance/contracts": {
"module": "fees",
"action": "read",
"description": "查询财务合同列表",
"default_roles": ["PM", "CRA", "IMP"],
},
"GET:/finance/contracts/{id}": {
"module": "fees",
"action": "read",
"description": "查询财务合同详情",
"default_roles": ["PM", "CRA", "IMP"],
},
"PATCH:/finance/contracts/{id}": {
"module": "fees",
"action": "write",
"description": "更新财务合同",
"default_roles": ["PM"],
},
"DELETE:/finance/contracts/{id}": {
"module": "fees",
"action": "write",
"description": "删除财务合同",
"default_roles": ["PM"],
},
# 费用管理 (fees)
"POST:/fees/contracts": {
"module": "fees",
"action": "write",
"description": "创建费用合同",
"default_roles": ["PM"],
},
"GET:/fees/contracts": {
"module": "fees",
"action": "read",
"description": "查询费用合同列表",
"default_roles": ["PM", "CRA", "IMP"],
},
"GET:/fees/contracts/{id}": {
"module": "fees",
"action": "read",
"description": "查询费用合同详情",
"default_roles": ["PM", "CRA", "IMP"],
},
"PATCH:/fees/contracts/{id}": {
"module": "fees",
"action": "write",
"description": "更新费用合同",
"default_roles": ["PM"],
},
"DELETE:/fees/contracts/{id}": {
"module": "fees",
"action": "write",
"description": "删除费用合同",
"default_roles": ["PM"],
},
"POST:/fees/contracts/{id}/payments": {
"module": "fees",
"action": "write",
"description": "创建费用分期",
"default_roles": ["PM"],
},
"PATCH:/fees/payments/{id}": {
"module": "fees",
"action": "write",
"description": "更新费用分期",
"default_roles": ["PM"],
},
"DELETE:/fees/payments/{id}": {
"module": "fees",
"action": "write",
"description": "删除费用分期",
"default_roles": ["PM"],
},
# 项目成员管理
"POST:/project-members": {
"module": "project_members",
"action": "write",
"description": "添加项目成员",
"default_roles": ["PM"],
},
"GET:/project-members": {
"module": "project_members",
"action": "read",
"description": "查询项目成员列表",
"default_roles": ["PM"],
},
"PATCH:/project-members/{id}": {
"module": "project_members",
"action": "write",
"description": "更新项目成员",
"default_roles": ["PM"],
},
# 中心管理
"POST:/sites": {
"module": "sites",
"action": "write",
"description": "创建中心",
"default_roles": ["PM"],
},
"GET:/sites": {
"module": "sites",
"action": "read",
"description": "查询中心列表",
"default_roles": ["PM", "CRA", "PV", "MEDICAL_REVIEW", "IMP", "QA"],
},
"GET:/sites/{id}": {
"module": "sites",
"action": "read",
"description": "查询中心详情",
"default_roles": ["PM", "CRA", "PV", "MEDICAL_REVIEW", "IMP", "QA"],
},
"PATCH:/sites/{id}": {
"module": "sites",
"action": "write",
"description": "更新中心",
"default_roles": ["PM"],
},
}
# 向后兼容:模块级权限到接口级权限的映射
# 用于在接口级权限未配置时,回退到模块级权限
MODULE_TO_ENDPOINTS: dict[str, dict[str, list[str]]] = {
"subjects": {
"read": [
"GET:/subjects",
"GET:/subjects/{id}",
"GET:/subjects/{subject_id}/visits",
"GET:/subjects/{subject_id}/visits/{visit_id}",
],
"write": [
"POST:/subjects",
"PATCH:/subjects/{id}",
"DELETE:/subjects/{id}",
"POST:/subjects/{subject_id}/visits",
"PATCH:/subjects/{subject_id}/visits/{visit_id}",
],
},
"risk_issues": {
"read": [
"GET:/risk-issues",
"GET:/risk-issues/{id}",
],
"write": [
"POST:/risk-issues",
"PATCH:/risk-issues/{id}",
"DELETE:/risk-issues/{id}",
],
},
"fees": {
"read": [
"GET:/fees/contracts",
"GET:/fees/contracts/{id}",
"GET:/finance/contracts",
"GET:/finance/contracts/{id}",
],
"write": [
"POST:/fees/contracts",
"PATCH:/fees/contracts/{id}",
"DELETE:/fees/contracts/{id}",
"POST:/fees/contracts/{id}/payments",
"PATCH:/fees/payments/{id}",
"DELETE:/fees/payments/{id}",
"POST:/finance/contracts",
"PATCH:/finance/contracts/{id}",
"DELETE:/finance/contracts/{id}",
],
},
"project_members": {
"read": [
"GET:/project-members",
],
"write": [
"POST:/project-members",
"PATCH:/project-members/{id}",
],
},
"sites": {
"read": [
"GET:/sites",
"GET:/sites/{id}",
],
"write": [
"POST:/sites",
"PATCH:/sites/{id}",
],
},
}
+119
View File
@@ -0,0 +1,119 @@
"""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()
+35 -1
View File
@@ -10,7 +10,7 @@ from app.core.security import decode_token, oauth2_scheme
from app.crud import user as user_crud
from app.crud import member as member_crud
from app.crud import site as site_crud
from app.core.project_permissions import role_has_project_permission
from app.core.project_permissions import role_has_project_permission, role_has_api_permission
from app.db.session import SessionLocal
from app.schemas.user import TokenPayload
@@ -147,6 +147,40 @@ def require_study_permission(module: str, action: str, *, allow_system_admin: bo
return dependency
def require_api_permission(endpoint_key: str, *, allow_system_admin: bool = True):
"""基于接口的权限检查
参数:
endpoint_key: 接口标识,格式为 "METHOD:/path",如 "POST:/subjects"
allow_system_admin: 是否允许系统管理员绕过权限检查
"""
async def dependency(
study_id: uuid.UUID,
current_user=Depends(get_current_user),
db: AsyncSession = Depends(get_db_session),
):
role_value = current_user.role.value if hasattr(current_user.role, "value") else current_user.role
if allow_system_admin and role_value == "ADMIN":
return current_user
membership = await member_crud.get_member(db, study_id, current_user.id)
if not membership or not membership.is_active:
raise AppException(
code="FORBIDDEN",
message="不是该项目成员",
status_code=status.HTTP_403_FORBIDDEN,
)
allowed = await role_has_api_permission(db, study_id, membership.role_in_study, endpoint_key)
if not allowed:
raise AppException(
code="FORBIDDEN",
message="接口权限不足",
status_code=status.HTTP_403_FORBIDDEN,
)
return current_user
return dependency
async def get_cra_site_scope(
db: AsyncSession,
study_id: uuid.UUID,
+113
View File
@@ -1,11 +1,14 @@
from __future__ import annotations
import json
import uuid
from sqlalchemy import delete, select
from sqlalchemy.ext.asyncio import AsyncSession
from app.models.study_role_permission import StudyRolePermission
from app.models.api_endpoint_permission import ApiEndpointPermission
from app.core.api_permissions import API_ENDPOINT_PERMISSIONS, MODULE_TO_ENDPOINTS
PROJECT_PERMISSION_ROLES = ("ADMIN", "PM", "CRA", "PV", "MEDICAL_REVIEW", "IMP", "QA")
@@ -249,3 +252,113 @@ async def role_has_project_permission(
if action == "write":
return bool(actions["write"])
return bool(actions["read"])
async def role_has_api_permission(
db: AsyncSession,
study_id: uuid.UUID,
role: str | None,
endpoint_key: str,
) -> bool:
"""检查角色是否有权访问特定接口
权限检查优先级:
1. 接口级权限(如果已配置)
2. 模块级权限(向后兼容)
"""
if role == "ADMIN":
return True
# 1. 先查询接口级权限
result = await db.execute(
select(ApiEndpointPermission).where(
ApiEndpointPermission.study_id == study_id,
ApiEndpointPermission.role == role,
ApiEndpointPermission.endpoint_key == endpoint_key,
)
)
perm = result.scalar_one_or_none()
if perm is not None:
return perm.allowed
# 2. 如果没有接口级权限,回退到模块级权限(向后兼容)
endpoint_config = API_ENDPOINT_PERMISSIONS.get(endpoint_key)
if not endpoint_config:
return False
module = endpoint_config["module"]
action = endpoint_config["action"]
return await role_has_project_permission(db, study_id, role, module, action)
async def get_api_endpoint_permissions(
db: AsyncSession,
study_id: uuid.UUID,
) -> dict[str, dict[str, dict[str, bool]]]:
"""获取项目的接口级权限矩阵
返回格式: {role: {endpoint_key: {allowed: bool}}}
"""
result = await db.execute(
select(ApiEndpointPermission).where(
ApiEndpointPermission.study_id == study_id,
)
)
rows = result.scalars().all()
# 初始化矩阵,包含所有角色和端点的默认权限
matrix: dict[str, dict[str, dict[str, bool]]] = {}
for role in PROJECT_PERMISSION_ROLES:
if role == "ADMIN":
continue
matrix[role] = {}
for endpoint_key, config in API_ENDPOINT_PERMISSIONS.items():
default_allowed = role in config.get("default_roles", [])
matrix[role][endpoint_key] = {"allowed": default_allowed}
# 覆盖自定义权限
for row in rows:
if row.role not in matrix:
matrix[row.role] = {}
matrix[row.role][row.endpoint_key] = {"allowed": row.allowed}
return matrix
async def replace_api_endpoint_permissions(
db: AsyncSession,
study_id: uuid.UUID,
payload: dict[str, dict[str, bool]],
) -> dict[str, dict[str, dict[str, bool]]]:
"""替换项目的接口级权限矩阵
参数:
payload: {role: {endpoint_key: allowed}}
返回格式: {role: {endpoint_key: {allowed: bool}}}
"""
# 删除该项目的所有接口级权限
await db.execute(
delete(ApiEndpointPermission).where(
ApiEndpointPermission.study_id == study_id,
)
)
# 插入新的权限配置
for role, endpoints in payload.items():
if role == "ADMIN":
continue
for endpoint_key, allowed in endpoints.items():
if endpoint_key not in API_ENDPOINT_PERMISSIONS:
continue
db.add(
ApiEndpointPermission(
study_id=study_id,
role=role,
endpoint_key=endpoint_key,
allowed=allowed,
)
)
await db.commit()
return await get_api_endpoint_permissions(db, study_id)