358 lines
15 KiB
Python
358 lines
15 KiB
Python
"""ZYT 管理员身份服务适配器。
|
||
|
||
桌面软件的密码只发送给 ZYT;客服后台拿到管理员 token 后通过最小会话接口验证,
|
||
再签发仅能访问客服数据的短期 token。
|
||
"""
|
||
|
||
from __future__ import annotations
|
||
|
||
import json
|
||
import os
|
||
import re
|
||
import socket
|
||
import urllib.error
|
||
import urllib.parse
|
||
import urllib.request
|
||
from typing import Any
|
||
|
||
|
||
WECOM_RPA_TERMINAL = 7
|
||
# 手机远程控制台。和桌面端(7)、网页后台(1)分开保存 ZYT 会话,互不顶号。
|
||
# 8 已被 ZYT 的 AI 浏览器(app/mcp/service/ConsoleService)占用,不能复用。
|
||
# 这个终端的登录只由客服后台代为发起,密码不经过任何第三方页面。
|
||
WECOM_RPA_MOBILE_TERMINAL = 9
|
||
DEFAULT_ZYT_API_BASE_URL = os.environ.get(
|
||
"ZYT_API_BASE_URL", "http://127.0.0.1"
|
||
).strip().rstrip("/")
|
||
|
||
|
||
class ZytAuthError(RuntimeError):
|
||
pass
|
||
|
||
|
||
class ZytLoginError(ZytAuthError):
|
||
"""ZYT 登录失败,并带上可供界面区分的原因。
|
||
|
||
kind 取值:
|
||
credentials 密码错误(ZYT 会按出口 IP 计入锁定次数)
|
||
unknown_account 账号不存在(ZYT 不计入锁定次数;对外提示与密码错误相同)
|
||
password_change_required 密码正确,但账号仍在用初始密码,须先到 ZYT 网页后台修改
|
||
locked ZYT 已按出口 IP 锁定登录,retry_after 为剩余秒数
|
||
disabled 管理员账号已停用
|
||
terminal_unsupported 线上 ZYT 还不认识手机终端 9
|
||
unavailable 网络、超时或 ZYT 返回了非预期数据
|
||
rejected 其他明确的拒绝(原样展示 ZYT 的提示)
|
||
"""
|
||
|
||
def __init__(self, message: str, *, kind: str = "rejected", retry_after: int = 0):
|
||
super().__init__(message)
|
||
self.kind = kind
|
||
self.retry_after = max(0, int(retry_after or 0))
|
||
|
||
|
||
def api_base_url() -> str:
|
||
value = DEFAULT_ZYT_API_BASE_URL
|
||
parsed = urllib.parse.urlparse(value)
|
||
if parsed.scheme not in {"http", "https"} or not parsed.netloc or parsed.username:
|
||
raise ZytAuthError("ZYT_API_BASE_URL 配置不正确")
|
||
return value.rstrip("/")
|
||
|
||
|
||
def verify_desktop_token(
|
||
token: str, *, api_url: str | None = None, timeout: float = 8.0
|
||
) -> dict[str, Any]:
|
||
token = str(token or "").strip()
|
||
if not token:
|
||
raise ZytAuthError("缺少 ZYT 登录令牌")
|
||
base_url = str(api_url or api_base_url()).strip().rstrip("/")
|
||
parsed = urllib.parse.urlparse(base_url)
|
||
if parsed.scheme not in {"http", "https"} or not parsed.netloc or parsed.username:
|
||
raise ZytAuthError("ZYT 登录 API 域名配置不正确")
|
||
last_error = "ZYT 登录已失效"
|
||
# 第一条是新版专用接口;第二条兼容尚未发布桌面终端的线上旧版。
|
||
endpoints = (
|
||
("/adminapi/desktop/session", False),
|
||
("/adminapi/auth.admin/mySelf", True),
|
||
)
|
||
for path, legacy in endpoints:
|
||
request = urllib.request.Request(
|
||
f"{base_url}{path}",
|
||
headers={
|
||
"Accept": "application/json",
|
||
"User-Agent": "WeCom-RPA-Backend/1.0",
|
||
# ZYT 管理端登录中间件读取 token 头,不是 Bearer。
|
||
"token": token,
|
||
},
|
||
method="GET",
|
||
)
|
||
try:
|
||
with urllib.request.urlopen(request, timeout=timeout) as response:
|
||
payload = json.loads(response.read().decode("utf-8"))
|
||
except urllib.error.HTTPError as exc:
|
||
last_error = f"ZYT 身份服务拒绝请求(HTTP {exc.code})"
|
||
# 只兼容尚未部署的路由;鉴权拒绝不能降级为网页身份。
|
||
if not legacy and exc.code in {404, 405}:
|
||
continue
|
||
raise ZytAuthError(last_error) from exc
|
||
except (urllib.error.URLError, TimeoutError, socket.timeout) as exc:
|
||
raise ZytAuthError(
|
||
f"无法连接 ZYT 身份服务:{getattr(exc, 'reason', exc)}"
|
||
) from exc
|
||
except (ValueError, TypeError, UnicodeDecodeError) as exc:
|
||
raise ZytAuthError("ZYT 身份服务返回了无效数据") from exc
|
||
|
||
if not isinstance(payload, dict):
|
||
raise ZytAuthError("ZYT 身份服务返回了无效数据")
|
||
if str(payload.get("code")) != "1":
|
||
last_error = str(
|
||
payload.get("msg") if isinstance(payload, dict) else ""
|
||
) or "ZYT 登录已失效"
|
||
if legacy and "ip" in last_error.lower() and "变化" in last_error:
|
||
raise ZytAuthError(
|
||
"ZYT 桌面认证接口尚未部署,旧版接口拒绝跨服务器验证。"
|
||
"请管理员部署 /adminapi/desktop/session 后重新登录"
|
||
)
|
||
raise ZytAuthError(last_error)
|
||
data = payload.get("data")
|
||
if not isinstance(data, dict):
|
||
raise ZytAuthError("ZYT 身份信息不完整")
|
||
|
||
if legacy:
|
||
admin = data.get("user")
|
||
if not isinstance(admin, dict) or not admin.get("id"):
|
||
raise ZytAuthError("ZYT 管理员身份信息不完整")
|
||
if int(admin.get("disable") or 0) != 0:
|
||
raise ZytAuthError("ZYT 管理员账号已停用")
|
||
permissions_value = data.get("permissions")
|
||
permissions = (
|
||
sorted(
|
||
{
|
||
str(item).strip()
|
||
for item in permissions_value
|
||
if str(item).strip()
|
||
}
|
||
)
|
||
if isinstance(permissions_value, list)
|
||
else []
|
||
)
|
||
role_ids_value = admin.get("role_ids")
|
||
role_ids: list[int] = []
|
||
if isinstance(role_ids_value, list):
|
||
for item in role_ids_value:
|
||
try:
|
||
role_ids.append(int(item))
|
||
except (TypeError, ValueError):
|
||
continue
|
||
profile_identity = {
|
||
"user_id": f"admin:{admin['id']}",
|
||
"sn": str(admin.get("account") or ""),
|
||
"nickname": str(admin.get("name") or admin.get("account") or ""),
|
||
"mobile": str(admin.get("phone") or ""),
|
||
"avatar": str(admin.get("avatar") or ""),
|
||
"terminal": WECOM_RPA_TERMINAL,
|
||
"status": "active",
|
||
"account_type": "admin",
|
||
"root": bool(int(admin.get("root") or 0)),
|
||
"role_ids": sorted(set(role_ids)),
|
||
"permissions": permissions,
|
||
"permissions_known": isinstance(permissions_value, list),
|
||
}
|
||
return profile_identity
|
||
|
||
identity = dict(data)
|
||
if not identity.get("user_id"):
|
||
raise ZytAuthError("ZYT 身份信息不完整")
|
||
if str(identity.get("terminal")) != str(WECOM_RPA_TERMINAL):
|
||
raise ZytAuthError("当前令牌不是企业微信客服桌面端令牌")
|
||
if str(identity.get("status") or "") != "active":
|
||
raise ZytAuthError("ZYT 管理员账号已停用")
|
||
permissions_value = identity.get("permissions")
|
||
identity["permissions"] = (
|
||
sorted(
|
||
{
|
||
str(item).strip()
|
||
for item in permissions_value
|
||
if str(item).strip()
|
||
}
|
||
)
|
||
if isinstance(permissions_value, list)
|
||
else []
|
||
)
|
||
identity["permissions_known"] = isinstance(permissions_value, list)
|
||
identity["root"] = bool(int(identity.get("root") or 0))
|
||
# 新版专用接口完整返回权限;旧版缺权限时保留未知状态,患者功能
|
||
# 按最小权限关闭,不再跨 IP 请求网页 mySelf 补权限。
|
||
return identity
|
||
|
||
raise ZytAuthError(last_error)
|
||
|
||
|
||
def _checked_base_url(api_url: str | None) -> str:
|
||
base_url = str(api_url or api_base_url()).strip().rstrip("/")
|
||
parsed = urllib.parse.urlparse(base_url)
|
||
if parsed.scheme not in {"http", "https"} or not parsed.netloc or parsed.username:
|
||
raise ZytLoginError("ZYT 登录 API 域名配置不正确", kind="unavailable")
|
||
return base_url
|
||
|
||
|
||
def _zyt_json(
|
||
method: str, url: str, *, payload: dict[str, Any] | None = None,
|
||
token: str = "", timeout: float,
|
||
) -> dict[str, Any]:
|
||
headers = {"Accept": "application/json", "User-Agent": "WeCom-RPA-Backend/1.0"}
|
||
body = None
|
||
if payload is not None:
|
||
body = json.dumps(payload, ensure_ascii=False).encode("utf-8")
|
||
headers["Content-Type"] = "application/json; charset=utf-8"
|
||
if token:
|
||
headers["token"] = token
|
||
request = urllib.request.Request(url, data=body, headers=headers, method=method)
|
||
try:
|
||
with urllib.request.urlopen(request, timeout=timeout) as response:
|
||
payload_out = json.loads(response.read().decode("utf-8"))
|
||
except urllib.error.HTTPError as exc:
|
||
raise ZytLoginError(
|
||
f"ZYT 身份服务拒绝请求(HTTP {exc.code})", kind="unavailable"
|
||
) from exc
|
||
except (urllib.error.URLError, TimeoutError, socket.timeout, OSError) as exc:
|
||
raise ZytLoginError(
|
||
f"无法连接 ZYT 身份服务:{getattr(exc, 'reason', exc)}", kind="unavailable"
|
||
) from exc
|
||
except (ValueError, TypeError, UnicodeDecodeError) as exc:
|
||
raise ZytLoginError("ZYT 身份服务返回了无效数据", kind="unavailable") from exc
|
||
if not isinstance(payload_out, dict):
|
||
raise ZytLoginError("ZYT 身份服务返回了无效数据", kind="unavailable")
|
||
return payload_out
|
||
|
||
|
||
_LOCK_MINUTES_RE = re.compile(r"(\d+)\s*分钟")
|
||
|
||
|
||
def _login_failure(message: str) -> ZytLoginError:
|
||
"""把 ZYT 登录接口的中文提示归类。
|
||
|
||
账号不存在和密码错误合并成同一句,免得手机端被拿来探测哪些账号存在。
|
||
"""
|
||
text = str(message or "").strip() or "ZYT 登录失败"
|
||
if "连续" in text and "分钟" in text:
|
||
match = _LOCK_MINUTES_RE.search(text.split("请", 1)[-1])
|
||
minutes = int(match.group(1)) if match else 30
|
||
return ZytLoginError(text, kind="locked", retry_after=max(1, minutes) * 60)
|
||
# ZYT 只在"账号存在、密码不对"时累计出口 IP 的失败次数(LoginValidate::password),
|
||
# 账号不存在直接返回、不计数。两者对外同一句话,对内要分开:限流预算只该为前者消耗。
|
||
if "密码错误" in text:
|
||
return ZytLoginError("账号或密码错误", kind="credentials")
|
||
if text == "账号不存在":
|
||
return ZytLoginError("账号或密码错误", kind="unknown_account")
|
||
if "禁用" in text or "停用" in text:
|
||
return ZytLoginError("该 ZYT 账号已停用,请联系管理员", kind="disabled")
|
||
if "terminal" in text.lower() or "终端" in text:
|
||
return ZytLoginError(
|
||
"ZYT 尚未开通企微客服手机端登录(终端 9),请联系管理员升级 ZYT",
|
||
kind="terminal_unsupported",
|
||
)
|
||
return ZytLoginError(text, kind="rejected")
|
||
|
||
|
||
def login_admin(
|
||
account: str, password: str, *, terminal: int = WECOM_RPA_MOBILE_TERMINAL,
|
||
api_url: str | None = None, timeout: float = 10.0,
|
||
) -> str:
|
||
"""用 ZYT 管理员账号密码换取指定终端的 token。只在服务端调用。"""
|
||
|
||
account = str(account or "").strip()
|
||
if not account or not password:
|
||
raise ZytLoginError("请输入账号和密码", kind="rejected")
|
||
base_url = _checked_base_url(api_url)
|
||
result = _zyt_json(
|
||
"POST", f"{base_url}/adminapi/login/account",
|
||
payload={"account": account, "password": str(password), "terminal": int(terminal)},
|
||
timeout=timeout,
|
||
)
|
||
if str(result.get("code")) != "1":
|
||
raise _login_failure(str(result.get("msg") or ""))
|
||
data = result.get("data")
|
||
token = str(data.get("token") or "").strip() if isinstance(data, dict) else ""
|
||
if not token:
|
||
raise ZytLoginError("ZYT 没有返回登录令牌", kind="unavailable")
|
||
# is_paw=0:管理员发放的初始密码还没改过。网页后台会强制先改密;这里是面向公网的
|
||
# 长期会话,同样不放行,并立即注销刚拿到的 ZYT 令牌。
|
||
if str(data.get("is_paw", 1)).strip() == "0":
|
||
logout_admin(token, api_url=base_url, timeout=timeout)
|
||
raise ZytLoginError(
|
||
"该账号仍在使用初始密码,请先登录 ZYT 网页后台修改密码,再使用手机控制台",
|
||
kind="password_change_required",
|
||
)
|
||
return token
|
||
|
||
|
||
def verify_admin_session(
|
||
token: str, *, terminal: int = WECOM_RPA_MOBILE_TERMINAL,
|
||
api_url: str | None = None, timeout: float = 8.0,
|
||
) -> dict[str, Any]:
|
||
"""通过 /adminapi/desktop/session 读取当前身份与权限,并核对终端类型。
|
||
|
||
与 ``verify_desktop_token`` 不同,这里没有旧版 mySelf 兜底:手机终端本身
|
||
就要求 ZYT 已升级,旧接口也不会返回终端 9。
|
||
"""
|
||
|
||
token = str(token or "").strip()
|
||
if not token:
|
||
raise ZytLoginError("缺少 ZYT 登录令牌", kind="rejected")
|
||
base_url = _checked_base_url(api_url)
|
||
try:
|
||
result = _zyt_json(
|
||
"GET", f"{base_url}/adminapi/desktop/session", token=token, timeout=timeout
|
||
)
|
||
except ZytLoginError as exc:
|
||
cause = exc.__cause__
|
||
if isinstance(cause, urllib.error.HTTPError) and cause.code in {404, 405}:
|
||
raise ZytLoginError(
|
||
"ZYT 尚未部署桌面身份接口,暂不能使用手机端", kind="terminal_unsupported"
|
||
) from exc
|
||
raise
|
||
if str(result.get("code")) != "1":
|
||
message = str(result.get("msg") or "").strip() or "ZYT 登录已失效"
|
||
if "不属于" in message and "桌面" in message:
|
||
raise ZytLoginError(
|
||
"ZYT 尚未开通企微客服手机端身份校验(终端 9),请联系管理员升级 ZYT",
|
||
kind="terminal_unsupported",
|
||
)
|
||
if "禁用" in message or "不存在" in message:
|
||
raise ZytLoginError("ZYT 管理员账号不存在或已停用", kind="disabled")
|
||
raise ZytLoginError(message, kind="rejected")
|
||
data = result.get("data")
|
||
if not isinstance(data, dict) or not data.get("user_id"):
|
||
raise ZytLoginError("ZYT 身份信息不完整", kind="unavailable")
|
||
identity = dict(data)
|
||
if str(identity.get("terminal")) != str(int(terminal)):
|
||
raise ZytLoginError(
|
||
"ZYT 尚未开通企微客服手机端身份校验(终端 9),请联系管理员升级 ZYT",
|
||
kind="terminal_unsupported",
|
||
)
|
||
if str(identity.get("status") or "") != "active":
|
||
raise ZytLoginError("ZYT 管理员账号已停用", kind="disabled")
|
||
permissions_value = identity.get("permissions")
|
||
identity["permissions"] = (
|
||
sorted({str(item).strip() for item in permissions_value if str(item).strip()})
|
||
if isinstance(permissions_value, list) else []
|
||
)
|
||
identity["permissions_known"] = isinstance(permissions_value, list)
|
||
identity["root"] = bool(int(identity.get("root") or 0))
|
||
return identity
|
||
|
||
|
||
def logout_admin(token: str, *, api_url: str | None = None, timeout: float = 5.0) -> None:
|
||
"""尽力注销 ZYT 侧会话;失败不影响本地登出。"""
|
||
|
||
token = str(token or "").strip()
|
||
if not token:
|
||
return
|
||
try:
|
||
_zyt_json(
|
||
"POST", f"{_checked_base_url(api_url)}/adminapi/login/logout",
|
||
payload={}, token=token, timeout=timeout,
|
||
)
|
||
except ZytAuthError:
|
||
return
|