Files
knowledge-governance/docs/DWS_LOGIN.md
T
姚章浩 b2cea6ed84
build / build (push) Successful in 1m52s
feat(settings): 新增 DWS 设备登录与目录连接检查
数据源配置可发起钉钉官方设备授权、重新授权和取消,完成后刷新共享账号状态并独立检查目录权限。
授权会话限定发起的管理员登录会话,令牌由现有 CLI 存储,取消等待子进程退出。

验证:完整 make verify 通过;前端 582 项、Go 1545 项通过,487 项声明的可选集成未运行。
授权处理器与 HTTP 边界通过 race 检查;本人钉钉授权仍由管理员在官方页面完成。
2026-11-17 16:59:47 +08:00

2.7 KiB

DWS 登录授权

管理员入口:系统设置 → 数据源配置 → 钉钉账号(DWS)。

  • 未登录时点击“登录授权”,在弹窗中打开钉钉官方授权页,由本人选择账号与组织并确认。
  • 平台等待设备授权完成。成功后自动刷新账号、组织和续期凭证有效期,并检查知识库、钉盘目录访问。
  • “重新授权”采用同一流程;授权中可取消,失败或过期后可重新发起。
  • “检查连接”只列目录与读取登录元数据,不登记来源、不扫描已有来源、不发起入库或生产发布。
  • 登录成功与目录可用分开显示;部分范围无权限时保留其他已成功范围,并展示原因。

服务端接线

API 直接管理 dws auth login --device --no-browser --format json 子进程,不复用旧浏览器扫码侧车。 CLI 负责官方 OAuth 协议、组织 CLI 权限校验及凭据加密持久化。平台只解析官方设备授权链接、用户授权码、有效期与状态;原始输出、access token、refresh token不进入接口或日志。

API 与 worker 必须使用相同 UID,以及同一组可写挂载:

配置 用途
DWS_BIN 固定版本的 DWS 程序
DWS_CONFIG_DIR 共享的 DWS 状态目录
DWS_HOME 共享 home,包含 .local/share/dws-cli 文件型密钥存储
DWS_DISABLE_KEYCHAIN=1 容器使用文件型凭据存储

子进程 HOME 由 DWS_HOME 指定,只透传所需环境。禁止把认证状态复制成多份,避免轮换令牌互相失效。

接口与生命周期

  • POST /api/v1/dws-login:立即返回 starting,后台生成设备授权;同一浏览器管理员会话重复请求复用在途授权。
  • GET /api/v1/dws-login/{id}:读取本人发起的授权。
  • DELETE /api/v1/dws-login/{id}:取消并等待旧 CLI 退出,清除授权链接与用户码。
  • 上述接口均为管理员专用;授权绑定管理员及其登录会话,另一会话无法读取或取消。
  • 创建和取消要求同源操作意图;响应禁止缓存。仅允许 https://login.dingtalk.com/oauth2/device/verify.htm 官方链接。
  • 每次只运行一个授权,防止覆盖共享状态。服务重启会结束在途授权;页面提示重新发起。
  • CLI 成功退出后必须再次读到有效本地凭据才显示登录成功;真实目录访问另行检查。

验证边界

自动回归覆盖授权生成、成功后状态更新、目录访问失败与部分可用、取消与进程退出、过期、重试、跨管理员/会话隔离、同源限制、官方链接校验及元数据脱敏。 真实本人授权需要管理员在钉钉官方页面确认;自动测试与生成真实授权链接不替代本人授权,也不证明其公司目录权限。