f1997d3194
- 新增 OIDC 认证配置项到 .env.template 文件 - 实现 OIDC 认证路由和处理逻辑，包括登录、回调和配置获取接口 - 创建 OIDC 配置模型和服务工具类，支持从环境变量加载配置 - 在前端登录页面添加 OIDC 登录选项，支持动态配置显示 - 添加 OIDC 认证相关配置文档说明 - 支持自动创建 OIDC 用户和部门管理功能
275 lines
9.5 KiB
Python
275 lines
9.5 KiB
Python
"""OIDC 认证路由模块
|
||
|
||
此模块包含 OIDC 认证相关的路由，需要被导入到主 auth_router.py 中使用。
|
||
"""
|
||
from urllib.parse import urlencode
|
||
from fastapi import Request
|
||
from fastapi.responses import RedirectResponse
|
||
from pydantic import BaseModel
|
||
from sqlalchemy import select
|
||
from yuxi.utils import logger
|
||
from yuxi.storage.postgres.models_business import User, Department
|
||
from yuxi.repositories.user_repository import UserRepository
|
||
from yuxi.repositories.department_repository import DepartmentRepository
|
||
from server.utils.auth_utils import AuthUtils
|
||
from server.utils.user_utils import generate_unique_user_id
|
||
from server.utils.oidc_config import oidc_config
|
||
from server.utils.oidc_utils import OIDCUtils
|
||
from server.utils.common_utils import log_operation
|
||
from yuxi.utils.datetime_utils import utc_now_naive
|
||
|
||
# 前端 OIDC 回调路由路径（与 web/src/router/index.js 中的路由保持一致）
|
||
FRONTEND_CALLBACK_PATH = "/auth/oidc/callback"
|
||
# 登录页路径（用于错误重定向）
|
||
FRONTEND_LOGIN_PATH = "/login"
|
||
|
||
|
||
# =============================================================================
|
||
# === OIDC 请求和响应模型 ===
|
||
# =============================================================================
|
||
|
||
class OIDCConfigResponse(BaseModel):
|
||
"""OIDC 配置响应"""
|
||
enabled: bool
|
||
login_url: str | None = None
|
||
provider_name: str | None = "OIDC登录"
|
||
|
||
|
||
class OIDCCallbackRequest(BaseModel):
|
||
"""OIDC 回调请求"""
|
||
code: str
|
||
state: str
|
||
|
||
|
||
class OIDCLoginResponse(BaseModel):
|
||
"""OIDC 登录响应"""
|
||
access_token: str
|
||
token_type: str
|
||
user_id: int
|
||
username: str
|
||
user_id_login: str
|
||
phone_number: str | None = None
|
||
avatar: str | None = None
|
||
role: str
|
||
department_id: int | None = None
|
||
department_name: str | None = None
|
||
|
||
|
||
# =============================================================================
|
||
# === OIDC 工具函数 ===
|
||
# =============================================================================
|
||
|
||
async def get_or_create_oidc_department(db) -> Department | None:
|
||
"""获取或创建 OIDC 用户的默认部门"""
|
||
dept_name = oidc_config.default_department
|
||
|
||
result = await db.execute(select(Department).filter(Department.name == dept_name))
|
||
dept = result.scalar_one_or_none()
|
||
|
||
if not dept:
|
||
# 创建 OIDC 用户部门
|
||
dept_repo = DepartmentRepository()
|
||
dept = await dept_repo.create({
|
||
"name": dept_name,
|
||
"description": f"{dept_name}部门",
|
||
})
|
||
logger.info(f"Created OIDC department: {dept_name}")
|
||
|
||
return dept
|
||
|
||
|
||
async def find_user_by_oidc_sub(db, sub: str) -> User | None:
|
||
"""通过 OIDC sub 查找用户"""
|
||
# OIDC 用户的 user_id 格式为: oidc:{sub}
|
||
oidc_user_id = f"oidc:{sub}"
|
||
result = await db.execute(select(User).filter(User.user_id == oidc_user_id, User.is_deleted == 0))
|
||
return result.scalar_one_or_none()
|
||
|
||
|
||
async def create_oidc_user(db, user_info: dict, department_id: int | None = None) -> User:
|
||
"""创建 OIDC 用户"""
|
||
user_repo = UserRepository()
|
||
|
||
sub = user_info["sub"]
|
||
username = user_info["name"] or user_info["username"]
|
||
email = user_info["email"]
|
||
|
||
# 生成唯一的 user_id
|
||
existing_user_ids = await user_repo.get_all_user_ids()
|
||
base_username = user_info["username"]
|
||
user_id = f"oidc:{sub}"
|
||
|
||
# 如果 oidc:{sub} 已存在，添加随机后缀
|
||
if user_id in existing_user_ids:
|
||
import uuid
|
||
user_id = f"oidc:{sub}:{uuid.uuid4().hex[:8]}"
|
||
|
||
# 生成随机密码（OIDC 用户不需要密码登录）
|
||
import secrets
|
||
random_password = secrets.token_urlsafe(32)
|
||
password_hash = AuthUtils.hash_password(random_password)
|
||
|
||
# 创建用户
|
||
new_user = await user_repo.create({
|
||
"username": username,
|
||
"user_id": user_id,
|
||
"phone_number": None, # OIDC 用户没有手机号
|
||
"avatar": None,
|
||
"password_hash": password_hash,
|
||
"role": oidc_config.default_role,
|
||
"department_id": department_id,
|
||
"last_login": utc_now_naive(),
|
||
})
|
||
|
||
logger.info(f"Created OIDC user: {username} ({user_id})")
|
||
return new_user
|
||
|
||
|
||
async def update_oidc_user_login(db, user: User) -> None:
|
||
"""更新 OIDC 用户登录时间"""
|
||
user.last_login = utc_now_naive()
|
||
await db.commit()
|
||
|
||
|
||
def _redirect_to_callback(token_data: dict) -> RedirectResponse:
|
||
"""成功后重定向到前端 OIDC 回调页面，通过 URL 参数传递登录数据"""
|
||
params: dict = {
|
||
"token": token_data["access_token"],
|
||
"user_id": str(token_data["user_id"]),
|
||
"username": token_data["username"],
|
||
"user_id_login": token_data["user_id_login"],
|
||
"role": token_data["role"],
|
||
}
|
||
if token_data.get("phone_number"):
|
||
params["phone_number"] = token_data["phone_number"]
|
||
if token_data.get("avatar"):
|
||
params["avatar"] = token_data["avatar"]
|
||
if token_data.get("department_id") is not None: # 0 is a valid id, so check explicitly
|
||
params["department_id"] = str(token_data["department_id"])
|
||
if token_data.get("department_name"):
|
||
params["department_name"] = token_data["department_name"]
|
||
|
||
url = f"{FRONTEND_CALLBACK_PATH}?{urlencode(params)}"
|
||
return RedirectResponse(url=url, status_code=302)
|
||
|
||
|
||
def _redirect_to_login_with_error(error_message: str) -> RedirectResponse:
|
||
"""失败时重定向到登录页并携带错误信息"""
|
||
url = f"{FRONTEND_LOGIN_PATH}?{urlencode({'oidc_error': error_message})}"
|
||
return RedirectResponse(url=url, status_code=302)
|
||
|
||
|
||
# =============================================================================
|
||
# === OIDC 路由处理函数 ===
|
||
# =============================================================================
|
||
|
||
async def get_oidc_config_handler():
|
||
"""获取 OIDC 配置（供前端使用）"""
|
||
if not oidc_config.enabled or not oidc_config.is_configured():
|
||
return OIDCConfigResponse(enabled=False)
|
||
|
||
login_url = await OIDCUtils.build_authorization_url()
|
||
provider_name = oidc_config.provider_name
|
||
return OIDCConfigResponse(enabled=True, login_url=login_url, provider_name=provider_name)
|
||
|
||
|
||
async def oidc_callback_handler(request: Request, code: str, state: str, db):
|
||
"""处理 OIDC 回调 - 重定向到前端 Vue 路由"""
|
||
|
||
# 验证 state
|
||
state_data = OIDCUtils.verify_state(state)
|
||
if not state_data:
|
||
return _redirect_to_login_with_error("登录会话已过期，请返回登录页重试")
|
||
|
||
# 用授权码交换令牌
|
||
token_response = await OIDCUtils.exchange_code_for_token(code)
|
||
if not token_response:
|
||
return _redirect_to_login_with_error("无法获取访问令牌，请返回登录页重试")
|
||
|
||
access_token = token_response.get("access_token")
|
||
if not access_token:
|
||
return _redirect_to_login_with_error("无法获取访问令牌，请返回登录页重试")
|
||
|
||
# 获取用户信息
|
||
userinfo = await OIDCUtils.get_userinfo(access_token)
|
||
if not userinfo:
|
||
return _redirect_to_login_with_error("无法获取用户信息，请返回登录页重试")
|
||
|
||
# 提取用户信息
|
||
extracted_info = OIDCUtils.extract_user_info(userinfo)
|
||
sub = extracted_info["sub"]
|
||
|
||
if not sub:
|
||
return _redirect_to_login_with_error("无法获取用户标识，请返回登录页重试")
|
||
|
||
# 查找或创建用户
|
||
user = await find_user_by_oidc_sub(db, sub)
|
||
|
||
if user:
|
||
# 更新登录时间
|
||
await update_oidc_user_login(db, user)
|
||
logger.info(f"OIDC user logged in: {user.username}")
|
||
elif oidc_config.auto_create_user:
|
||
# 获取或创建 OIDC 部门
|
||
dept = await get_or_create_oidc_department(db)
|
||
department_id = dept.id if dept else None
|
||
|
||
# 创建新用户
|
||
user = await create_oidc_user(db, extracted_info, department_id)
|
||
else:
|
||
return _redirect_to_login_with_error("用户未注册，请联系管理员开通账号")
|
||
|
||
# 检查用户是否被删除
|
||
if user.is_deleted:
|
||
return _redirect_to_login_with_error("该账户已注销")
|
||
|
||
# 生成访问令牌
|
||
token_data = {"sub": str(user.id)}
|
||
jwt_token = AuthUtils.create_access_token(token_data)
|
||
|
||
# 记录登录操作
|
||
await log_operation(db, user.id, "OIDC 登录")
|
||
|
||
# 获取部门名称
|
||
department_name = None
|
||
if user.department_id:
|
||
result = await db.execute(select(Department.name).filter(Department.id == user.department_id))
|
||
department_name = result.scalar_one_or_none()
|
||
|
||
# 构建响应数据
|
||
response_data = {
|
||
"access_token": jwt_token,
|
||
"token_type": "bearer",
|
||
"user_id": user.id,
|
||
"username": user.username,
|
||
"user_id_login": user.user_id,
|
||
"phone_number": user.phone_number,
|
||
"avatar": user.avatar,
|
||
"role": user.role,
|
||
"department_id": user.department_id,
|
||
"department_name": department_name,
|
||
}
|
||
|
||
# 重定向到前端 OIDC 回调 Vue 页面
|
||
return _redirect_to_callback(response_data)
|
||
|
||
|
||
async def oidc_login_url_handler(redirect_path: str = "/"):
|
||
"""获取 OIDC 登录 URL"""
|
||
from fastapi import HTTPException, status
|
||
|
||
if not oidc_config.enabled or not oidc_config.is_configured():
|
||
raise HTTPException(
|
||
status_code=status.HTTP_503_SERVICE_UNAVAILABLE,
|
||
detail="OIDC is not enabled or not configured"
|
||
)
|
||
|
||
login_url = await OIDCUtils.build_authorization_url(redirect_path)
|
||
if not login_url:
|
||
raise HTTPException(
|
||
status_code=status.HTTP_500_INTERNAL_SERVER_ERROR,
|
||
detail="Failed to build authorization URL"
|
||
)
|
||
|
||
return {"login_url": login_url}
|