hermes_external_auth.py 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298
  1. """Web sign-in for the providers whose Hermes dashboard entry is ``flow: external``.
  2. Each flow drives Hermes's own credential code and storage:
  3. - qwen-oauth device code + PKCE against Qwen's OAuth server (the flow the Qwen CLI runs), tokens
  4. saved with Hermes's ``_save_qwen_cli_tokens`` (~/.qwen/oauth_creds.json, 0600)
  5. - copilot GitHub device code with Hermes's Copilot client id; token saved as
  6. ``COPILOT_GITHUB_TOKEN`` in .env, exactly like ``hermes model`` → Copilot → option 1
  7. - copilot-acp runs ``copilot login`` on the server and surfaces its URL/code
  8. - anthropic / claude-code
  9. paste a token: an API key or a ``claude setup-token`` token minted by Anthropic's own
  10. client. No in-app PKCE: Hermes keeps that flow terminal-only on purpose (minting
  11. Claude subscription tokens from a scriptable HTTP endpoint is against Anthropic's
  12. OAuth usage policies), and Yaovi respects that boundary.
  13. Endpoints can be redirected with YAOVI_HERMES_TEST_* variables, which only tests set.
  14. """
  15. from __future__ import annotations
  16. import base64
  17. import hashlib
  18. import json
  19. import os
  20. import re
  21. import secrets
  22. import subprocess
  23. import threading
  24. import time
  25. import urllib.error
  26. import urllib.parse
  27. import urllib.request
  28. import uuid
  29. from typing import Any
  30. WEB_FLOWS = {
  31. "qwen-oauth": "device_code",
  32. "copilot": "device_code",
  33. "copilot-acp": "process",
  34. "anthropic": "paste_token",
  35. "claude-code": "paste_token",
  36. }
  37. EXTRA_PROVIDERS = [ # API-key providers whose Hermes setup also offers an OAuth device login
  38. {"id": "copilot", "name": "GitHub Copilot", "flow": "external", "cli_command": "hermes model",
  39. "docs_url": "https://docs.github.com/en/copilot", "disconnect_hint": None, "disconnect_command": None,
  40. "disconnectable": True},
  41. ]
  42. _sessions: dict[str, dict[str, Any]] = {}
  43. _lock = threading.Lock()
  44. class AuthFlowError(Exception):
  45. def __init__(self, status: int, message: str):
  46. super().__init__(message)
  47. self.status = status
  48. def _qwen_base() -> str:
  49. return os.environ.get("YAOVI_HERMES_TEST_QWEN_OAUTH_BASE", "https://chat.qwen.ai").rstrip("/")
  50. def _github_base() -> str:
  51. return os.environ.get("YAOVI_HERMES_TEST_GITHUB_BASE", "https://github.com").rstrip("/")
  52. def _post_form(url: str, fields: dict[str, str], timeout: float = 15) -> dict[str, Any]:
  53. req = urllib.request.Request(url, data=urllib.parse.urlencode(fields).encode(), headers={
  54. "Accept": "application/json", "User-Agent": "HermesAgent/1.0",
  55. "Content-Type": "application/x-www-form-urlencoded"})
  56. try:
  57. with urllib.request.urlopen(req, timeout=timeout) as resp:
  58. return json.loads(resp.read().decode() or "{}")
  59. except urllib.error.HTTPError as e: # OAuth errors (authorization_pending…) arrive as 4xx JSON
  60. try:
  61. return json.loads(e.read().decode() or "{}")
  62. except Exception:
  63. return {"error": f"http_{e.code}"}
  64. except (urllib.error.URLError, OSError, ValueError) as e:
  65. raise AuthFlowError(502, f"无法连接登录服务:{getattr(e, 'reason', e)}")
  66. def _new_session(provider: str, flow: str, **extra: Any) -> dict[str, Any]:
  67. sid = uuid.uuid4().hex
  68. sess = {"id": sid, "provider": provider, "flow": flow, "status": "pending", "error_message": None,
  69. "created": time.time(), "cancel": threading.Event(), **extra}
  70. with _lock:
  71. _sessions[sid] = sess
  72. return sess
  73. def _finish(sess: dict[str, Any], status: str, error: str | None = None) -> None:
  74. sess["status"], sess["error_message"] = status, error
  75. def owns(session_id: str) -> bool:
  76. with _lock:
  77. return session_id in _sessions
  78. def decorate(listing: dict[str, Any]) -> dict[str, Any]:
  79. """Tag each external provider with the web flow Yaovi can run for it."""
  80. providers = listing.get("providers", [])
  81. known = {p["id"] for p in providers}
  82. for extra in EXTRA_PROVIDERS:
  83. if extra["id"] not in known:
  84. providers.append({**extra, "status": copilot_status()})
  85. for p in providers:
  86. if p["id"] in WEB_FLOWS:
  87. p["web_flow"] = WEB_FLOWS[p["id"]]
  88. listing["providers"] = providers
  89. return listing
  90. def copilot_status() -> dict[str, Any]:
  91. from hermes_cli.config import get_env_value
  92. token = get_env_value("COPILOT_GITHUB_TOKEN") or ""
  93. return {"logged_in": bool(token), "source_label": "COPILOT_GITHUB_TOKEN" if token else None,
  94. "token_preview": token[-4:] if token else None}
  95. # ── device code flows ─────────────────────────────────────────────────────────────────────────
  96. def _start_qwen() -> dict[str, Any]:
  97. from hermes_cli.auth_constants import QWEN_OAUTH_CLIENT_ID
  98. verifier = base64.urlsafe_b64encode(secrets.token_bytes(32)).rstrip(b"=").decode()
  99. challenge = base64.urlsafe_b64encode(hashlib.sha256(verifier.encode()).digest()).rstrip(b"=").decode()
  100. data = _post_form(f"{_qwen_base()}/api/v1/oauth2/device/code", {
  101. "client_id": QWEN_OAUTH_CLIENT_ID, "scope": "openid profile email model.completion",
  102. "code_challenge": challenge, "code_challenge_method": "S256"})
  103. if not data.get("device_code") or not data.get("user_code"):
  104. raise AuthFlowError(502, f"Qwen 未返回设备码:{data.get('error_description') or data.get('error') or '未知错误'}")
  105. sess = _new_session("qwen-oauth", "device_code", expires_at=time.time() + int(data.get("expires_in") or 600))
  106. interval = max(int(data.get("interval") or 5), 1)
  107. def poll() -> None:
  108. fields = {"grant_type": "urn:ietf:params:oauth:grant-type:device_code", "client_id": QWEN_OAUTH_CLIENT_ID,
  109. "device_code": data["device_code"], "code_verifier": verifier}
  110. nonlocal interval
  111. while time.time() < sess["expires_at"] and not sess["cancel"].wait(interval):
  112. result = _post_form(f"{_qwen_base()}/api/v1/oauth2/token", fields)
  113. if result.get("access_token"):
  114. from hermes_cli.auth_qwen import _save_qwen_cli_tokens
  115. _save_qwen_cli_tokens({
  116. "access_token": result["access_token"], "refresh_token": result.get("refresh_token", ""),
  117. "token_type": result.get("token_type", "Bearer"), "resource_url": result.get("resource_url", ""),
  118. "expiry_date": int((time.time() + int(result.get("expires_in") or 3600)) * 1000)})
  119. return _finish(sess, "approved")
  120. err = result.get("error", "")
  121. if err == "slow_down":
  122. interval += 5
  123. elif err != "authorization_pending":
  124. return _finish(sess, "denied" if err == "access_denied" else "error", result.get("error_description") or err or "登录失败")
  125. if sess["status"] == "pending":
  126. _finish(sess, "cancelled" if sess["cancel"].is_set() else "expired")
  127. threading.Thread(target=poll, daemon=True).start()
  128. return {"session_id": sess["id"], "flow": "device_code", "user_code": data["user_code"],
  129. "verification_url": data.get("verification_uri_complete") or data.get("verification_uri") or "",
  130. "expires_in": int(data.get("expires_in") or 600), "poll_interval": interval}
  131. def _start_copilot() -> dict[str, Any]:
  132. # Provider discovery registers the bundled, pinned upstream plugin namespace.
  133. from providers import get_provider_profile
  134. if get_provider_profile("copilot") is None:
  135. raise AuthFlowError(503, "GitHub Copilot 模型插件不可用。")
  136. from plugins.model_providers.github_copilot.copilot.credentials import COPILOT_OAUTH_CLIENT_ID
  137. data = _post_form(f"{_github_base()}/login/device/code", {"client_id": COPILOT_OAUTH_CLIENT_ID, "scope": "read:user"})
  138. if not data.get("device_code") or not data.get("user_code"):
  139. raise AuthFlowError(502, "GitHub 未返回设备码")
  140. sess = _new_session("copilot", "device_code", expires_at=time.time() + int(data.get("expires_in") or 900))
  141. interval = max(int(data.get("interval") or 5), 1)
  142. def poll() -> None:
  143. nonlocal interval
  144. fields = {"client_id": COPILOT_OAUTH_CLIENT_ID, "device_code": data["device_code"],
  145. "grant_type": "urn:ietf:params:oauth:grant-type:device_code"}
  146. while time.time() < sess["expires_at"] and not sess["cancel"].wait(interval):
  147. result = _post_form(f"{_github_base()}/login/oauth/access_token", fields, 10)
  148. if result.get("access_token"):
  149. from hermes_cli.config import save_env_value
  150. save_env_value("COPILOT_GITHUB_TOKEN", result["access_token"])
  151. return _finish(sess, "approved")
  152. err = result.get("error", "")
  153. if err == "slow_down":
  154. interval = int(result.get("interval") or interval + 5)
  155. elif err != "authorization_pending":
  156. return _finish(sess, "denied" if err == "access_denied" else "error", result.get("error_description") or err or "登录失败")
  157. if sess["status"] == "pending":
  158. _finish(sess, "cancelled" if sess["cancel"].is_set() else "expired")
  159. threading.Thread(target=poll, daemon=True).start()
  160. return {"session_id": sess["id"], "flow": "device_code", "user_code": data["user_code"],
  161. "verification_url": data.get("verification_uri") or "https://github.com/login/device",
  162. "expires_in": int(data.get("expires_in") or 900), "poll_interval": interval}
  163. # ── external process (copilot login) ─────────────────────────────────────────────────────────
  164. _URL_RE = re.compile(r"https?://[^\s'\"<>]+")
  165. _CODE_RE = re.compile(r"\b([A-Z0-9]{4}-[A-Z0-9]{4})\b")
  166. def _start_copilot_acp() -> dict[str, Any]:
  167. command = os.environ.get("YAOVI_HERMES_TEST_COPILOT_CMD")
  168. if not command:
  169. from hermes_cli.auth_external_process import resolve_external_process_command
  170. command = resolve_external_process_command("copilot")
  171. if not command:
  172. raise AuthFlowError(409, "服务器上没有安装 GitHub Copilot CLI(copilot),请先安装后再登录。")
  173. from model_network import process_env
  174. proc = subprocess.Popen([command, "login"], stdin=subprocess.DEVNULL, stdout=subprocess.PIPE,
  175. stderr=subprocess.STDOUT, text=True, bufsize=1, env={**process_env("copilot-acp"), "NO_COLOR": "1"})
  176. sess = _new_session("copilot-acp", "process", proc=proc, url="", code="", expires_at=time.time() + 900)
  177. seen = threading.Event()
  178. def pump() -> None:
  179. for line in proc.stdout: # type: ignore[union-attr]
  180. if not sess["url"] and (m := _URL_RE.search(line)):
  181. sess["url"] = m.group(0).rstrip(".,)")
  182. if not sess["code"] and (m := _CODE_RE.search(line)):
  183. sess["code"] = m.group(1)
  184. if sess["url"] and sess["code"]:
  185. seen.set()
  186. code = proc.wait()
  187. seen.set()
  188. if sess["status"] == "pending":
  189. _finish(sess, "approved" if code == 0 else ("cancelled" if sess["cancel"].is_set() else "error"),
  190. None if code == 0 else f"copilot login 退出码 {code}")
  191. threading.Thread(target=pump, daemon=True).start()
  192. seen.wait(20)
  193. if sess["status"] == "error":
  194. raise AuthFlowError(502, sess["error_message"] or "copilot login 失败")
  195. return {"session_id": sess["id"], "flow": "process", "user_code": sess["code"],
  196. "verification_url": sess["url"] or "https://github.com/login/device", "expires_in": 900, "poll_interval": 3}
  197. # ── paste token (Anthropic) ──────────────────────────────────────────────────────────────────
  198. def submit_token(provider: str, token: str) -> dict[str, Any]:
  199. token = (token or "").strip()
  200. if WEB_FLOWS.get(provider) != "paste_token":
  201. raise AuthFlowError(400, "该供应商不支持粘贴凭据")
  202. if not token or len(token) > 4096 or re.search(r"\s", token):
  203. raise AuthFlowError(400, "凭据格式无效")
  204. from hermes_cli.config import save_env_value
  205. if token.startswith("sk-ant-oat"):
  206. var = "CLAUDE_CODE_OAUTH_TOKEN" # `claude setup-token` output
  207. elif token.startswith("sk-ant-") and provider == "anthropic":
  208. var = "ANTHROPIC_API_KEY"
  209. else:
  210. raise AuthFlowError(400, "请粘贴以 sk-ant- 开头的 Anthropic API Key,或 `claude setup-token` 生成的令牌")
  211. save_env_value(var, token)
  212. return {"ok": True, "env_var": var}
  213. # ── dispatch ──────────────────────────────────────────────────────────────────────────────────
  214. def start(provider: str) -> dict[str, Any]:
  215. flow = WEB_FLOWS.get(provider)
  216. if flow == "paste_token":
  217. raise AuthFlowError(400, "请粘贴凭据(API Key 或 setup-token)")
  218. starter = {"qwen-oauth": _start_qwen, "copilot": _start_copilot, "copilot-acp": _start_copilot_acp}.get(provider)
  219. if not starter:
  220. raise AuthFlowError(400, f"{provider} 没有可用的网页登录")
  221. return starter()
  222. def poll(provider: str, session_id: str) -> dict[str, Any]:
  223. with _lock:
  224. sess = _sessions.get(session_id)
  225. if not sess or sess["provider"] != provider:
  226. raise AuthFlowError(404, "登录会话不存在或已过期")
  227. if sess["status"] == "pending" and time.time() > sess["expires_at"]:
  228. cancel(session_id)
  229. _finish(sess, "expired")
  230. out = {"session_id": session_id, "status": sess["status"], "error_message": sess["error_message"]}
  231. if sess["flow"] == "process":
  232. out.update(user_code=sess["code"], verification_url=sess["url"])
  233. return out
  234. def cancel(session_id: str) -> dict[str, Any]:
  235. with _lock:
  236. sess = _sessions.get(session_id)
  237. if sess:
  238. sess["cancel"].set()
  239. proc = sess.get("proc")
  240. if proc and proc.poll() is None:
  241. proc.terminate()
  242. if sess["status"] == "pending":
  243. _finish(sess, "cancelled")
  244. return {"ok": True}
  245. def disconnect(provider: str) -> dict[str, Any]:
  246. from hermes_cli.config import remove_env_value
  247. if provider == "copilot":
  248. remove_env_value("COPILOT_GITHUB_TOKEN")
  249. return {"ok": True}
  250. raise AuthFlowError(400, "unsupported")