service.py 20 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652
  1. import json
  2. import uuid
  3. from datetime import datetime, timedelta
  4. from typing import NewType
  5. from fastapi import Request
  6. from redis.asyncio.client import Redis
  7. from sqlalchemy.ext.asyncio import AsyncSession
  8. from user_agents import parse
  9. from app.api.v1.module_monitor.online.schema import OnlineOutSchema
  10. from app.api.v1.module_system.user.crud import UserCRUD
  11. from app.api.v1.module_system.user.model import UserModel
  12. from app.common.enums import RedisInitKeyConfig
  13. from app.config.setting import settings
  14. from app.core.exceptions import CustomException
  15. from app.core.logger import log
  16. from app.core.redis_crud import RedisCURD
  17. from app.core.security import (
  18. CustomOAuth2PasswordRequestForm,
  19. create_access_token,
  20. decode_access_token,
  21. )
  22. from app.utils.captcha_util import CaptchaUtil
  23. from app.utils.common_util import get_random_character
  24. from app.utils.hash_bcrpy_util import PwdUtil
  25. from app.utils.ip_local_util import IpLocalUtil
  26. from .schema import (
  27. AuthSchema,
  28. AutoLoginTokenSchema,
  29. AutoLoginUserSchema,
  30. CaptchaOutSchema,
  31. JWTOutSchema,
  32. JWTPayloadSchema,
  33. LoginMiniRequestSchema,
  34. LogoutPayloadSchema,
  35. RefreshTokenPayloadSchema, SmsCodeSchema,
  36. )
  37. CaptchaKey = NewType("CaptchaKey", str)
  38. CaptchaBase64 = NewType("CaptchaBase64", str)
  39. class LoginService:
  40. """登录认证服务"""
  41. @classmethod
  42. async def authenticate_mini_user_service(
  43. cls,
  44. request: Request,
  45. redis: Redis,
  46. login_form: LoginMiniRequestSchema,
  47. db: AsyncSession,
  48. ) -> JWTOutSchema:
  49. # 小程序用户认证
  50. auth = AuthSchema(db=db)
  51. user = await UserCRUD(auth).get_by_username_crud(username=login_form.username)
  52. if not user:
  53. raise CustomException(msg="用户不存在")
  54. if not PwdUtil.verify_password(
  55. plain_password=login_form.password, password_hash=user.password
  56. ):
  57. raise CustomException(msg="账号或密码错误")
  58. if user.status == "1":
  59. raise CustomException(msg="用户已被停用")
  60. # 更新最后登录时间
  61. user = await UserCRUD(auth).update_last_login_crud(id=user.id)
  62. if not user:
  63. raise CustomException(msg="用户不存在")
  64. if not login_form.login_type:
  65. raise CustomException(msg="登录类型不能为空")
  66. # 创建token
  67. token = await cls.create_token_service(
  68. request=request,
  69. redis=redis,
  70. user=user,
  71. login_type=login_form.login_type,
  72. )
  73. return token
  74. @classmethod
  75. async def authenticate_user_service(
  76. cls,
  77. request: Request,
  78. redis: Redis,
  79. login_form: CustomOAuth2PasswordRequestForm,
  80. db: AsyncSession,
  81. ) -> JWTOutSchema:
  82. """
  83. 用户认证
  84. 参数:
  85. - request (Request): FastAPI请求对象
  86. - login_form (CustomOAuth2PasswordRequestForm): 登录表单数据
  87. - db (AsyncSession): 数据库会话对象
  88. 返回:
  89. - JWTOutSchema: 包含访问令牌和刷新令牌的响应模型
  90. 异常:
  91. - CustomException: 认证失败时抛出异常。
  92. """
  93. # 判断是否来自API文档
  94. referer = request.headers.get("referer", "")
  95. request_from_docs = referer.endswith(("docs", "redoc"))
  96. # 验证码校验
  97. if settings.CAPTCHA_ENABLE and not request_from_docs:
  98. if not login_form.captcha_key or not login_form.captcha:
  99. raise CustomException(msg="验证码不能为空")
  100. await CaptchaService.check_captcha_service(
  101. redis=redis,
  102. key=login_form.captcha_key,
  103. captcha=login_form.captcha,
  104. )
  105. # 用户认证
  106. auth = AuthSchema(db=db)
  107. user = await UserCRUD(auth).get_by_username_crud(username=login_form.username)
  108. if not user:
  109. raise CustomException(msg="用户不存在")
  110. if not PwdUtil.verify_password(
  111. plain_password=login_form.password, password_hash=user.password
  112. ):
  113. raise CustomException(msg="账号或密码错误")
  114. if user.status == "1":
  115. raise CustomException(msg="用户已被停用")
  116. # 更新最后登录时间
  117. user = await UserCRUD(auth).update_last_login_crud(id=user.id)
  118. if not user:
  119. raise CustomException(msg="用户不存在")
  120. if not login_form.login_type:
  121. raise CustomException(msg="登录类型不能为空")
  122. # 创建token
  123. token = await cls.create_token_service(
  124. request=request,
  125. redis=redis,
  126. user=user,
  127. login_type=login_form.login_type,
  128. )
  129. return token
  130. @classmethod
  131. async def create_token_service(
  132. cls, request: Request, redis: Redis, user: UserModel, login_type: str
  133. ) -> JWTOutSchema:
  134. """
  135. 创建访问令牌和刷新令牌
  136. 参数:
  137. - request (Request): FastAPI请求对象
  138. - redis (Redis): Redis客户端对象
  139. - user (UserModel): 用户模型对象
  140. - login_type (str): 登录类型
  141. 返回:
  142. - JWTOutSchema: 包含访问令牌和刷新令牌的响应模型
  143. 异常:
  144. - CustomException: 创建令牌失败时抛出异常。
  145. """
  146. # 生成会话编号
  147. session_id = str(uuid.uuid4())
  148. request.scope["session_id"] = session_id
  149. user_agent = parse(request.headers.get("user-agent"))
  150. request_ip = None
  151. x_forwarded_for = request.headers.get("X-Forwarded-For")
  152. if x_forwarded_for:
  153. # 取第一个 IP 地址,通常为客户端真实 IP
  154. request_ip = x_forwarded_for.split(",")[0].strip()
  155. else:
  156. # 若没有 X-Forwarded-For 头,则使用 request.client.host
  157. request_ip = request.client.host if request.client else "127.0.0.1"
  158. login_location = await IpLocalUtil.resolve_location_for_log(request_ip)
  159. request.scope["login_location"] = login_location
  160. # 确保在请求上下文中设置用户名和会话ID
  161. request.scope["user_username"] = user.username
  162. access_expires = timedelta(seconds=settings.ACCESS_TOKEN_EXPIRE_MINUTES)
  163. refresh_expires = timedelta(seconds=settings.REFRESH_TOKEN_EXPIRE_MINUTES)
  164. now = datetime.now()
  165. # 记录租户信息到日志
  166. log.info(f"用户ID: {user.id}, 用户名: {user.username} 正在生成JWT令牌")
  167. # 生成会话信息
  168. session_info = OnlineOutSchema(
  169. session_id=session_id,
  170. user_id=user.id,
  171. name=user.name,
  172. user_name=user.username,
  173. ipaddr=request_ip,
  174. login_location=login_location,
  175. os=user_agent.os.family,
  176. browser=user_agent.browser.family,
  177. login_time=user.last_login,
  178. login_type=login_type,
  179. ).model_dump_json()
  180. access_token = create_access_token(
  181. payload=JWTPayloadSchema(
  182. sub=session_info,
  183. is_refresh=False,
  184. exp=now + access_expires,
  185. )
  186. )
  187. refresh_token = create_access_token(
  188. payload=JWTPayloadSchema(
  189. sub=session_info,
  190. is_refresh=True,
  191. exp=now + refresh_expires,
  192. )
  193. )
  194. # 设置新的token
  195. await RedisCURD(redis).set(
  196. key=f"{RedisInitKeyConfig.ACCESS_TOKEN.key}:{session_id}",
  197. value=access_token,
  198. expire=int(access_expires.total_seconds()),
  199. )
  200. await RedisCURD(redis).set(
  201. key=f"{RedisInitKeyConfig.REFRESH_TOKEN.key}:{session_id}",
  202. value=refresh_token,
  203. expire=int(refresh_expires.total_seconds()),
  204. )
  205. return JWTOutSchema(
  206. access_token=access_token,
  207. refresh_token=refresh_token,
  208. expires_in=int(access_expires.total_seconds()),
  209. token_type=settings.TOKEN_TYPE,
  210. )
  211. @classmethod
  212. async def refresh_token_service(
  213. cls,
  214. db: AsyncSession,
  215. redis: Redis,
  216. request: Request,
  217. refresh_token: RefreshTokenPayloadSchema,
  218. ) -> JWTOutSchema:
  219. """
  220. 刷新访问令牌
  221. 参数:
  222. - db (AsyncSession): 数据库会话对象
  223. - redis (Redis): Redis客户端对象
  224. - request (Request): FastAPI请求对象
  225. - refresh_token (RefreshTokenPayloadSchema): 刷新令牌数据
  226. 返回:
  227. - JWTOutSchema: 新的令牌对象
  228. 异常:
  229. - CustomException: 刷新令牌无效时抛出异常
  230. """
  231. token_payload: JWTPayloadSchema = decode_access_token(token=refresh_token.refresh_token)
  232. if not token_payload.is_refresh:
  233. raise CustomException(msg="非法凭证,请传入刷新令牌")
  234. # 去 Redis 查完整信息
  235. session_info = json.loads(token_payload.sub)
  236. session_id = session_info.get("session_id")
  237. user_id = session_info.get("user_id")
  238. if not session_id or not user_id:
  239. raise CustomException(msg="非法凭证,无法获取会话编号或用户ID")
  240. # 用户认证
  241. auth = AuthSchema(db=db)
  242. user = await UserCRUD(auth).get_by_id_crud(id=user_id)
  243. if not user:
  244. raise CustomException(msg="刷新token失败,用户不存在")
  245. # 记录刷新令牌时的租户信息
  246. log.info(f"用户ID: {user.id}, 用户名: {user.username} 正在刷新JWT令牌")
  247. # 设置新的 token
  248. access_expires = timedelta(seconds=settings.ACCESS_TOKEN_EXPIRE_MINUTES)
  249. refresh_expires = timedelta(seconds=settings.REFRESH_TOKEN_EXPIRE_MINUTES)
  250. now = datetime.now()
  251. session_info_json = json.dumps(session_info)
  252. access_token = create_access_token(
  253. payload=JWTPayloadSchema(
  254. sub=session_info_json,
  255. is_refresh=False,
  256. exp=now + access_expires,
  257. )
  258. )
  259. refresh_token_new = create_access_token(
  260. payload=JWTPayloadSchema(
  261. sub=session_info_json,
  262. is_refresh=True,
  263. exp=now + refresh_expires,
  264. )
  265. )
  266. # 覆盖写入 Redis
  267. await RedisCURD(redis).set(
  268. key=f"{RedisInitKeyConfig.ACCESS_TOKEN.key}:{session_id}",
  269. value=access_token,
  270. expire=int(access_expires.total_seconds()),
  271. )
  272. await RedisCURD(redis).set(
  273. key=f"{RedisInitKeyConfig.REFRESH_TOKEN.key}:{session_id}",
  274. value=refresh_token_new,
  275. expire=int(refresh_expires.total_seconds()),
  276. )
  277. return JWTOutSchema(
  278. access_token=access_token,
  279. refresh_token=refresh_token_new,
  280. token_type=settings.TOKEN_TYPE,
  281. expires_in=int(access_expires.total_seconds()),
  282. )
  283. @classmethod
  284. async def logout_service(cls, redis: Redis, token: LogoutPayloadSchema) -> bool:
  285. """
  286. 退出登录
  287. 参数:
  288. - redis (Redis): Redis客户端对象
  289. - token (LogoutPayloadSchema): 退出登录令牌数据
  290. 返回:
  291. - bool: 退出成功返回True
  292. 异常:
  293. - CustomException: 令牌无效时抛出异常
  294. """
  295. payload: JWTPayloadSchema = decode_access_token(token=token.token)
  296. session_info = json.loads(payload.sub)
  297. session_id = session_info.get("session_id")
  298. if not session_id:
  299. raise CustomException(msg="非法凭证,无法获取会话编号")
  300. # 删除Redis中的在线用户、访问令牌、刷新令牌
  301. await RedisCURD(redis).delete(f"{RedisInitKeyConfig.ACCESS_TOKEN.key}:{session_id}")
  302. await RedisCURD(redis).delete(f"{RedisInitKeyConfig.REFRESH_TOKEN.key}:{session_id}")
  303. log.info(f"用户退出登录成功,会话编号:{session_id}")
  304. return True
  305. class CaptchaService:
  306. """验证码服务"""
  307. @classmethod
  308. async def get_captcha_service(cls, redis: Redis) -> dict[str, CaptchaKey | CaptchaBase64]:
  309. """
  310. 获取验证码
  311. 参数:
  312. - redis (Redis): Redis客户端对象
  313. 返回:
  314. - dict[str, CaptchaKey | CaptchaBase64]: 包含验证码key和base64图片的字典
  315. 异常:
  316. - CustomException: 验证码服务未启用时抛出异常
  317. """
  318. if not settings.CAPTCHA_ENABLE:
  319. raise CustomException(msg="未开启验证码服务")
  320. # 生成验证码图片和值
  321. captcha_base64, captcha_value = CaptchaUtil.captcha_arithmetic()
  322. captcha_key = get_random_character()
  323. # 保存到Redis并设置过期时间
  324. redis_key = f"{RedisInitKeyConfig.CAPTCHA_CODES.key}:{captcha_key}"
  325. await RedisCURD(redis).set(
  326. key=redis_key,
  327. value=captcha_value,
  328. expire=settings.CAPTCHA_EXPIRE_SECONDS,
  329. )
  330. log.info(f"生成验证码成功,验证码:{captcha_value}")
  331. # 返回验证码信息
  332. return CaptchaOutSchema(
  333. enable=settings.CAPTCHA_ENABLE,
  334. key=CaptchaKey(captcha_key),
  335. img_base=CaptchaBase64(f"data:image/png;base64,{captcha_base64}"),
  336. ).model_dump()
  337. @classmethod
  338. async def check_captcha_service(cls, redis: Redis, key: str, captcha: str) -> bool:
  339. """
  340. 校验验证码
  341. 参数:
  342. - redis (Redis): Redis客户端对象
  343. - key (str): 验证码key
  344. - captcha (str): 用户输入的验证码
  345. 返回:
  346. - bool: 验证通过返回True
  347. 异常:
  348. - CustomException: 验证码无效或错误时抛出异常
  349. """
  350. if not captcha:
  351. raise CustomException(msg="验证码不能为空")
  352. # 获取Redis中存储的验证码
  353. redis_key = f"{RedisInitKeyConfig.CAPTCHA_CODES.key}:{key}"
  354. captcha_value = await RedisCURD(redis).get(redis_key)
  355. if not captcha_value:
  356. log.error("验证码已过期或不存在")
  357. raise CustomException(msg="验证码已过期")
  358. # 验证码不区分大小写比对
  359. if captcha.lower() != captcha_value.lower():
  360. log.error(f"验证码错误,用户输入:{captcha},正确值:{captcha_value}")
  361. raise CustomException(msg="验证码错误")
  362. # 验证成功后删除验证码,避免重复使用
  363. await RedisCURD(redis).delete(redis_key)
  364. log.info(f"验证码校验成功,key:{key}")
  365. return True
  366. class AutoLoginService:
  367. """免登录服务"""
  368. # 免登录Token前缀
  369. AUTO_LOGIN_PREFIX = "fastapiadmin:auto_login:"
  370. # Token有效期(秒) - 5分钟
  371. TOKEN_EXPIRE = 300
  372. @classmethod
  373. async def get_auto_login_users_service(cls, db: AsyncSession) -> list[AutoLoginUserSchema]:
  374. """
  375. 获取免登录用户列表
  376. 参数:
  377. - db (AsyncSession): 数据库会话对象
  378. 返回:
  379. - list[AutoLoginUserSchema]: 用户列表
  380. """
  381. from sqlalchemy import select
  382. from app.api.v1.module_system.user.model import UserModel
  383. # 查询所有启用的用户
  384. stmt = select(UserModel).where(UserModel.status == "0").order_by(UserModel.id)
  385. result = await db.execute(stmt)
  386. users = result.scalars().all()
  387. return [
  388. AutoLoginUserSchema(
  389. id=user.id,
  390. username=user.username,
  391. name=user.name,
  392. avatar=user.avatar,
  393. )
  394. for user in users
  395. ]
  396. @classmethod
  397. async def create_auto_login_token_service(
  398. cls, redis: Redis, db: AsyncSession, user_id: int
  399. ) -> AutoLoginTokenSchema:
  400. """
  401. 创建免登录Token
  402. 参数:
  403. - request (Request): FastAPI请求对象
  404. - redis (Redis): Redis客户端对象
  405. - db (AsyncSession): 数据库会话对象
  406. - user_id (int): 用户ID
  407. 返回:
  408. - AutoLoginTokenSchema: 免登录Token和用户信息
  409. 异常:
  410. - CustomException: 用户不存在或已停用时抛出异常
  411. """
  412. from sqlalchemy import select
  413. from app.api.v1.module_system.user.model import UserModel
  414. # 查询用户
  415. stmt = select(UserModel).where(UserModel.id == user_id)
  416. result = await db.execute(stmt)
  417. user = result.scalar_one_or_none()
  418. if not user:
  419. raise CustomException(msg="用户不存在")
  420. if user.status == "1":
  421. raise CustomException(msg="用户已被停用")
  422. # 生成免登录Token
  423. import uuid
  424. token = str(uuid.uuid4())
  425. token_key = f"{cls.AUTO_LOGIN_PREFIX}{token}"
  426. # 存储到Redis,设置5分钟过期
  427. token_data = {
  428. "user_id": user.id,
  429. "username": user.username,
  430. "created_at": datetime.now().isoformat(),
  431. }
  432. await RedisCURD(redis).set(
  433. key=token_key,
  434. value=json.dumps(token_data),
  435. expire=cls.TOKEN_EXPIRE,
  436. )
  437. log.info(f"创建免登录Token成功,用户:{user.username}")
  438. return AutoLoginTokenSchema(
  439. token=token,
  440. user=AutoLoginUserSchema(
  441. id=user.id,
  442. username=user.username,
  443. name=user.name,
  444. avatar=user.avatar,
  445. ),
  446. )
  447. @classmethod
  448. async def auto_login_service(
  449. cls, request: Request, redis: Redis, db: AsyncSession, token: str
  450. ) -> JWTOutSchema:
  451. """
  452. 免登录
  453. 参数:
  454. - request (Request): FastAPI请求对象
  455. - redis (Redis): Redis客户端对象
  456. - db (AsyncSession): 数据库会话对象
  457. - token (str): 免登录Token
  458. 返回:
  459. - JWTOutSchema: JWT令牌信息
  460. 异常:
  461. - CustomException: Token无效或过期时抛出异常
  462. """
  463. from sqlalchemy import select
  464. from app.api.v1.module_system.user.model import UserModel
  465. # 验证Token
  466. token_key = f"{cls.AUTO_LOGIN_PREFIX}{token}"
  467. token_data_str = await RedisCURD(redis).get(token_key)
  468. if not token_data_str:
  469. raise CustomException(msg="免登录Token已过期或无效")
  470. token_data = json.loads(token_data_str)
  471. user_id = token_data.get("user_id")
  472. # 查询用户
  473. stmt = select(UserModel).where(UserModel.id == user_id)
  474. result = await db.execute(stmt)
  475. user = result.scalar_one_or_none()
  476. if not user:
  477. raise CustomException(msg="用户不存在")
  478. if user.status == "1":
  479. raise CustomException(msg="用户已被停用")
  480. # 删除已使用的Token
  481. await RedisCURD(redis).delete(token_key)
  482. # 使用LoginService创建token
  483. jwt_token = await LoginService.create_token_service(
  484. request=request, redis=redis, user=user, login_type="PC端"
  485. )
  486. log.info(f"用户{user.username}免登录成功")
  487. return jwt_token
  488. class SmsCodeService:
  489. """短信验证码服务"""
  490. SMS_CODE_PREFIX = "sms_code"
  491. SMS_CODE_EXPIRE = 60 * 5
  492. @classmethod
  493. async def send_sms_code_service(
  494. cls, sms_code: SmsCodeSchema, redis: Redis
  495. ) -> None:
  496. """
  497. 发送短信验证码
  498. 参数:
  499. - smsCode (SmsCodeSchema): 短信验证码请求模型
  500. - redis (Redis): Redis客户端对象
  501. 异常:
  502. - CustomException: 验证码发送失败时抛出异常。
  503. """
  504. pass
  505. @classmethod
  506. async def verify_sms_code_service(
  507. cls, sms_code: SmsCodeSchema, redis: Redis
  508. ) -> bool:
  509. """
  510. 验证短信验证码
  511. 参数:
  512. - smsCode (SmsCodeSchema): 短信验证码请求模型
  513. - redis (Redis): Redis客户端对象
  514. 返回:
  515. - bool: 验证结果
  516. 异常:
  517. - CustomException: 验证码验证失败时抛出异常。
  518. """
  519. redis_key = f"{cls.SMS_CODE_PREFIX}:{sms_code.mobile}"
  520. code = await RedisCURD(redis).get(redis_key)
  521. if not code or code != sms_code.code:
  522. return False
  523. return True