Files
tick-stock-panel/backend/app/secrets_store.py
T
shy3130 ea746b97c7 feat(plugins): 新增 fuyao 同花顺官方实时行情插件(默认 hidden)与插件 Key 界面配置
- fuyao 插件: 全市场实时快照分页拉取, 字段对齐数据契约(pct 百分制÷100),
  兼容官方文档与实际返回两种信封/字段名; 优化完成前 plugin.yaml 标记
  hidden: true, 加载器跳过注册不展示, 删除该行即可开放
- plugin.yaml 新增 api_key_env 约定: 设置页提供 Key 输入框, 先探后存
  (POST/DELETE /api/settings/plugin-key), secrets.json 优先于 .env
- secrets_store.get_env_backed_secret(field, env_name) 支持插件取 Key
- loader: 插件状态透出 api_key_env, 新增 probe_plugin_key 委托探测
- 31 个插件测试; docs/plugin-development.md 补充约定说明
2026-08-24 14:21:38 +08:00

120 lines
3.3 KiB
Python

"""Key / 凭据本地存储(§14)。
存储位置:`data/user_data/secrets.json`,权限 0600。
优先级:secrets.json > .env > 空(Free 模式)。
UI 改 Key 时只动这个文件,不动 .env。
"""
from __future__ import annotations
import json
import logging
import os
from pathlib import Path
logger = logging.getLogger(__name__)
def _path() -> Path:
from app.config import settings
p = settings.data_dir / "user_data" / "secrets.json"
p.parent.mkdir(parents=True, exist_ok=True)
return p
def load() -> dict:
p = _path()
if p.exists():
try:
return json.loads(p.read_text(encoding="utf-8"))
except Exception as e: # noqa: BLE001
logger.warning("secrets.json malformed: %s", e)
return {}
def save(updates: dict) -> dict:
"""合并写入(不会清掉未提及的字段)。返回新内容。"""
current = load()
current.update({k: v for k, v in updates.items() if v is not None})
p = _path()
p.write_text(json.dumps(current, indent=2, ensure_ascii=False), encoding="utf-8")
try:
os.chmod(p, 0o600)
except OSError:
pass
return current
def clear(*keys: str) -> dict:
"""清掉指定字段(留空清全部)。"""
p = _path()
if not p.exists():
return {}
if not keys:
p.unlink()
return {}
current = load()
for k in keys:
current.pop(k, None)
p.write_text(json.dumps(current, indent=2, ensure_ascii=False), encoding="utf-8")
return current
def get_tickflow_key() -> str:
"""取当前 TickFlow Key:secrets.json 优先,否则 .env。"""
val = load().get("tickflow_api_key")
if val:
return val
from app.config import settings
return settings.tickflow_api_key or ""
def get_ai_key() -> str:
"""取当前 AI Key:secrets.json 优先,否则 .env。"""
val = load().get("ai_api_key")
if val:
return val
from app.config import settings
return settings.ai_api_key or ""
def get_ai_config(key: str, default: str = "") -> str:
"""取 AI 配置项:secrets.json 优先,否则 config。"""
val = load().get(key)
if val:
return val
from app.config import settings
return getattr(settings, key, default) or default
def get_ai_config_int(key: str, default: int) -> int:
"""取 AI 数值配置项 (如 ai_max_output_tokens): secrets.json 优先,否则 config。"""
val = load().get(key)
if val is not None:
try:
return int(val)
except (TypeError, ValueError):
logger.warning("ai config %s is not an int: %r", key, val)
from app.config import settings
return int(getattr(settings, key, default) or default)
def get_env_backed_secret(field: str, env_name: str) -> str:
"""取环境变量后备的密钥(插件 API Key 等):secrets.json 优先,否则环境变量。
与 get_tickflow_key 同优先级语义:UI 写入 secrets.json 后即覆盖 .env。
"""
val = load().get(field)
if val:
return str(val).strip()
return os.environ.get(env_name, "").strip()
def mask(key: str, prefix: int = 4, suffix: int = 4) -> str:
"""脱敏显示。"""
if not key:
return ""
if len(key) <= prefix + suffix:
return "•" * len(key)
return f"{key[:prefix]}{'•' * 6}{key[-suffix:]}"