98 lines
11 KiB
Markdown
98 lines
11 KiB
Markdown
# SDD-002：opsx-vpn 桌面客户端与 WireGuard 接入评估
|
||
|
||
| 字段 | 内容 |
|
||
|---|---|
|
||
| 版本 / 变更级别 | 0.1 / S3（未来涉及设备凭据、系统路由和隧道权限） |
|
||
| 设计状态 | Draft |
|
||
| 实现状态 | 客户端骨架、只读本机工具检测及托盘入口；拨号功能未实现 |
|
||
| 负责人 / 日期 | 待指定 / 2026-10-21 |
|
||
| 关联需求 | 仓库根目录新增 `client/`，Rust + Tauri v2 桌面客户端，优先对接 WireGuard |
|
||
| 批准状态 | 用户要求评估并新增客户端；后续接口契约尚待确认 |
|
||
|
||
## 1. 背景、目标与范围
|
||
|
||
- **当前行为与证据**：[服务端路由](../../backend/internal/api/api.go)的 `/api/login` 是管理账号登录，`/api/tunnels/:id/wireguard/peers` 的读写与配置下载需要 operator 以上角色；[WireGuard 实现](../../backend/internal/service/wireguard/wireguard.go)可以为管理端生成 Peer 私钥和 `.conf`，新增/删除 Peer 会停止再启动正在运行的隧道。节点 API `/api/nodes` 是管理节点信息，尚不是面向终端用户的可用线路目录。
|
||
- **目标**：参考 `../opsxshell` 与 `../opsxapi` 的桌面项目形态，在 `client/` 建立独立 Tauri v2 + Rust + React/TypeScript 项目；第一阶段只做可验证的真实服务健康检查和清晰的接入状态；给出后续控制面/数据面改造顺序。
|
||
- **非目标**：第一阶段不使用管理员令牌给终端用户创建 Peer，不自动安装驱动、修改本机 DNS/路由或连接 VPN，不兼容飞连私有协议，不宣称飞书/LDAP 用户已经能领取 WireGuard 设备配置。
|
||
- **保留行为**：现有 `frontend/` 管理后台、现有 WireGuard 隧道和已经签发的 Peer 均不改变；服务端 Go 与桌面 Rust 独立构建。
|
||
|
||
## 2. 需求与约束
|
||
|
||
- FR-01：桌面端可输入控制面 HTTPS 地址，使用 Rust 命令调用现有 `/api/health` 并显示真实结果；仅允许明确的本机 HTTP 开发地址。
|
||
- FR-02：界面将“服务已可达”与“用户已登录/隧道已连接”分开显示；尚无客户端 API 时连接控制不可触发拨号，预览节点及延时必须在界面显著标记为演示数据。
|
||
- FR-02a：桌面端采用蓝白灰连接概览、窄侧栏和独立线路弹窗；预览延时以绿、黄区分，但不伪装为实时测量。只有真实健康检查可展示控制面往返耗时，且明确不等于 VPN 节点延时。
|
||
- FR-02b：托盘明确显示未连接，并提供打开窗口与退出；设置页只读检查本机 PATH 中是否存在 `wg`、`wg-quick`，不得把工具存在等同于可拨号或已连接。
|
||
- FR-03（后续）：专门的终端用户认证、MFA/OIDC 与短期设备令牌；区分管理员和拨号用户，过期、退出及设备撤销有可验证行为。
|
||
- FR-04（后续）：由桌面端生成并保管 WireGuard 私钥，只上传公钥；服务端按用户/设备身份分配地址、Peer、路由及 DNS，签发有限时配置并处理回收。
|
||
- FR-05（后续）：针对 Windows/macOS/Linux 的系统隧道、权限、路由/DNS 回滚和断线恢复逐平台交付；首版仅标准 WireGuard UDP。
|
||
- NFR-01：应用不能请求广泛的 shell/filesystem 权限；客户端机密不进入前端源码、日志或仓库。桌面应用与管理 API 使用不同鉴权边界。
|
||
- NFR-02：健康检查超时且 TLS 默认验证证书；失败时展示可读原因，不把网络失败当 VPN 连接失败。
|
||
|
||
## 3. 架构与取舍
|
||
|
||
```text
|
||
React 页面 → Tauri invoke → Rust 命令/服务 → opsx-vpn 控制面 HTTPS
|
||
│ 登录/授权/设备与 Peer（后续）
|
||
└→ 标准 WireGuard UDP 网关
|
||
Rust 系统隧道适配层（后续） ← 仅在本机保存的 WireGuard 私钥
|
||
```
|
||
|
||
- 客户端采用 `client/src` + `client/src-tauri`，参考同族项目的轻量 Tauri v2 壳，不复制其 SSH/HTTP 工作台或许可证逻辑。UI 使用 React + TypeScript；网络请求由 Rust 执行，避免将控制面令牌交给 WebView。
|
||
- UI 参考用户提供的蓝白灰截图与 Clash Verge Rev 的桌面交互分层思路；Clash Verge Rev 是 GPL-3.0-only，未复制其源码和视觉资源。线路列表目前是固定的演示内容，选择仅更新当前页面状态，不写入持久配置、不进行网络探测或拨号。
|
||
- `corplink-rs`、`Client_UI_for_Corplink` 与 PinkD 的 `wireguard-go` 面向飞连私有控制协议；现有 opsx-vpn 使用 Linux `wg`/`wg-quick` 和标准 WireGuard。不要引入 `protocol_version` 等私有扩展或假设它们兼容。SOCKS5/netstack、WireGuard over TCP 另行评估。
|
||
- 可选的近期验证路线：由管理员在现有管理端下载独立测试 Peer 配置，再用目标 OS 的标准 WireGuard 客户端验证网关；桌面端的自动拨号必须等设备 API 和权限模型明确后再做。
|
||
|
||
### Clash Verge Rev 参考范围与接入顺序
|
||
|
||
已只读核对本地 `../demo/clash-verge-rev` 的 `src-tauri/src/lib.rs`、`ipc.rs`、`feat/tun.rs`、`core/tray/`、`core/service.rs`、`core/updater.rs` 与 Tauri 配置。其 Tauri IPC 类型与命令集中管理、托盘状态、服务可用性检测、配置写入失败恢复以及按平台拆分是可参考的**设计方式**；该项目的系统代理、Mihomo TUN/服务、订阅配置及更新地址都不能直接用于 opsx-vpn。其 GPL-3.0-only 源码、图标和界面资源不复制进当前仓库。
|
||
|
||
| 顺序 | 借鉴方向 | opsx-vpn 需要自行实现或验证的前置条件 |
|
||
|---|---|---|
|
||
| 1 | Rust IPC 边界、连接状态模型、节点选择、托盘显示 | 先有独立的终端用户身份/设备授权 API；托盘只能根据真实握手与系统隧道状态宣称“已连接”，演示数据不能进入托盘 |
|
||
| 2 | 服务可用性检查、失败恢复、跨平台权限管理 | 使用目标系统支持的**标准 WireGuard** 隧道方案，分别验证安装/卸载、DNS/路由保存与恢复、崩溃及重启行为；不以 Mihomo TUN 或系统代理开关替代 WireGuard |
|
||
| 3 | 配置存储与更新流程 | 私钥在客户端安全存储，令牌按平台凭据库管理；普通偏好与机密分离。具备签名、可信发布地址和回滚策略后才添加自动更新 |
|
||
|
||
`corplink-rs` 仅在明确提出**兼容飞连官方服务**且确认私有协议、许可与长期维护成本后作为研究参考，不能作为本项目认证或隧道实现的基础。当前项目的认证对象是 opsx-vpn 自己的 LDAP/飞书用户，需由 opsx-vpn 签发客户端设备身份；飞连企业识别码、Cookie、私有 WireGuard 扩展字段不属于本项目契约。
|
||
|
||
## 4. 接口、数据与配置契约
|
||
|
||
- 第一阶段复用 `GET /api/health`，不新增服务端 API、不改变数据库或现有 Peer 数据。
|
||
- 桌面原生命令 `get_system_readiness` 返回操作系统和 PATH 中 `wg`、`wg-quick` 文件存在性；不执行这些工具、不申请特权，也不访问 VPN 凭据。托盘当前仅提供未连接静态状态、打开与退出，未来需绑定真实隧道状态机后才能展示连接状态。
|
||
- 桌面 `check_server(base_url)` 只返回地址、是否可达及错误，不持久化用户口令或令牌。默认不配置公网地址；用户自行填真实 HTTPS 域名，开发时允许 `http://127.0.0.1` / `http://localhost`。
|
||
- 后续拟新增独立的客户端 `/api/client/*` 契约：登录/续期、可用线路、设备注册（公钥、设备标识）、设备吊销、连接配置领取及状态。响应不下发服务端私钥，客户端私钥不上传。接口形状、LDAP/飞书绑定与授权范围在实现前另行确定。
|
||
- 配置下载目前包含由服务端保存的客户端私钥，不得将管理员下载接口直接暴露给桌面端；现有管理员 `/api/login` 不等价于终端用户准入。
|
||
|
||
## 5. 风险与验收
|
||
|
||
| 风险或失败场景 | 处理方式 | 可观察信号 |
|
||
|---|---|---|
|
||
| 把管理 token 当拨号凭据 | 另建按用户/设备授权的控制面；第一阶段仅匿名健康检查 | 无管理 API 调用 |
|
||
| 设备私钥从管理配置泄漏 | 后续客户端生成密钥、公钥注册及撤销；不直接调用管理下载接口 | 设备 API 与密钥审计 |
|
||
| Peer 更新影响现有连接 | 后续用 `wg set` 等增量更新并测试掉线影响，再启用自动注册 | 连接连续性、审计日志 |
|
||
| Windows/macOS/Linux 权限差异 | 按平台单独设计特权 helper、安装与回滚；第一阶段不创建 TUN | 平台专项验收 |
|
||
|
||
| AC | 对应需求 | 前置与操作 | 预期结果 | 验证方式 | 状态 |
|
||
|---|---|---|---|---|---|
|
||
| AC-01 | FR-01, NFR-02 | 输入有效/无效/非本机 HTTP 地址并点检测 | 真实健康结果、错误与拒绝行为明确 | Rust 单测、桌面手动试连 | 地址校验及本机健康接口测试通过；真实服务与桌面手动试连待做 |
|
||
| AC-02 | FR-02, FR-02a, NFR-01 | 打开桌面端并切换线路 | 蓝白灰界面、绿黄演示延时、显著的演示标记；可见未接入，不会调用管理 API 或修改系统 | UI 构建、代码检查、桌面演示启动 | UI 构建通过；桌面 demo 进程已启动，手动视觉验收待做 |
|
||
| AC-02b | FR-02b, NFR-01 | 在桌面端打开托盘并访问设置页 | 托盘显示未连接，能打开/退出；本机工具存在性仅标注为 PATH 检查结果 | 原生构建、桌面手动检查 | UI 构建及 Rust 测试通过，Tauri 开发进程已重启；托盘点击与设置页人工验收待做 |
|
||
| AC-03 | FR-03 | 普通用户/MFA/过期令牌/撤销设备 | 仅已授权设备可领取配置 | 后续 API 集成测试 | Not Run |
|
||
| AC-04 | FR-04 | 同一用户多个设备注册/注销 | 各设备独立密钥、Peer、地址与审计 | 后续真实网关联调 | Not Run |
|
||
| AC-05 | FR-05 | 各 OS 正常连接与异常退出 | 路由/DNS 可恢复，不影响已有连接 | 后续目标 OS 实机验收 | Not Run |
|
||
|
||
## 6. 发布与恢复
|
||
|
||
- 第一阶段仅新增 `client/`，不修改服务器进程、不申请系统特权；构建检查与桌面手动健康检查后才能称为可运行。
|
||
- 2026-10-21 已经管理 API 在现有服务器上创建停止状态测试专线 `opsx-client-pilot`（ID 4），配置与只读核验见 [WireGuard API 创建记录](../wireguard-api-create.md)。该资源尚未启动，不代表桌面客户端可以认证或连接；启用前确认云安全组与目标路由。
|
||
- 后续按“独立客户端身份 API → 设备注册/增量 Peer 更新 → Linux/Windows/macOS 原生隧道”逐步交付；先在独立测试 WireGuard 隧道验证。
|
||
- 若后续客户端版本故障，先禁用其设备访问凭据并停用客户端，保留现有管理后台与隧道；数据迁移需独立备份和回滚方案。
|
||
|
||
## 7. 待决问题
|
||
|
||
| 问题 | 是否阻塞第一阶段 | 建议 |
|
||
|---|---|---|
|
||
| 首发 OS 与安装包签名 | 不阻塞骨架 | 先选一台真实目标 OS 验收，再扩平台 |
|
||
| 企业账号映射到 VPN 权限、MFA/OIDC 与设备配额 | 阻塞自动拨号 | 稳定用户 ID + 单独设备授权策略，不按同名邮箱猜测 |
|
||
| 会话断开是否自动注销 Peer | 阻塞自动拨号 | 区分临时连接与已授权设备；明确租约、续期与撤销 |
|
||
| 是否需要代理模式/TCP/飞连兼容 | 不阻塞标准 WireGuard UDP | 先证明原生 WG 客户端与当前网关互通 |
|