mirror of
https://github.com/modelstudioai/cli.git
synced 2026-09-14 19:49:23 +08:00
5.5 KiB
5.5 KiB
鉴权扩展
触发条件
- 增加新的鉴权域或 token 来源(env / config / flag / 文件)
- 调整 API Key / Console token 解析优先级
- 改
bl auth login/auth status/auth logout流程 - 改 runtime 对 command
auth的 gating 或 credential 注入
鉴权链路
argv flags ─┐
env var ──┼─ buildSources(flags) ─┐
config ──┘ │
├─ buildSettings(sources) → ctx.settings
│
├─ resolveApiKey(sources) → model-domain Client
└─ resolveConsole(sources) → console-domain Client
defineCommand({ auth }) → runtime/authStage → ctx.client → command.run(ctx)
当前 command 鉴权域(AuthRequirement):
apiKey— DashScope / OpenAI-compatible 模型域,用 API key 与 model base URLconsole— Bailian Console Gateway,用 console access token + region/site/switchAgent/workspacenone— 本地命令、登录/配置类命令、无需 credential 的命令
双凭证并存(API Key + Console)
~/.bailian/config.json 可同时保存 api_key 与 access_token。登录任一种方式不得删除另一种:
bl auth login --api-key ...只更新api_key/base_urlbl auth login --console只更新access_token以及回调携带的 console 作用域字段bl auth logout --console只清access_tokenbl auth logout清api_key+access_token
解析分工:
resolveApiKey()—auth: "apiKey"命令;优先级--api-key>DASHSCOPE_API_KEY> configapi_keyresolveModelBaseUrl()— model base URL;优先级--base-url>DASHSCOPE_BASE_URL> configbase_url>REGIONS.cnresolveConsole()—auth: "console"命令;当前 token 来自 configaccess_token,region/site/switchAgent 来自 flag > config > 默认describeAuthState()—auth status/ banner / telemetry 使用的只读快照
命令不要直接解析 token、env 或 config。业务请求统一走 ctx.client;登录/配置命令通过 ctx.authStore() / ctx.configStore() 的窄接口操作落盘。
必查清单
A. core 层(类型 + 解析)
packages/core/src/types/command.ts:- 如新增鉴权域,扩展
AuthRequirement - 更新
credentialFlagDefs()暴露该域可见的 flag - 必要时新增
*_AUTH_FLAGS
- 如新增鉴权域,扩展
packages/core/src/auth/types.ts:- 新增 credential 类型 / source / scope 字段
packages/core/src/auth/resolver.ts:- 新增或调整 resolver,保持优先级注释清晰
- 新增/调整 resolver hint 时保持产品无关,不要新增
bl/rag硬编码;当前遗留的bl auth loginhint 如被触碰,迁到 runtimeenhanceHint
packages/core/src/auth/store.ts:- 如果新方式需要持久化,扩展
AuthStore/AuthPersistPatch
- 如果新方式需要持久化,扩展
packages/core/src/config/schema.ts:ConfigFile加 disk 字段(snake_case)Settings加运行时字段(如果命令需要读取)
packages/core/src/config/loader.ts:buildSources()/buildSettings()把 flag/env/file 读到正确层
B. runtime 层
packages/runtime/src/create-cli.ts:- parse flags 时纳入新的全局/凭证域 flag
globalFlags与ownFlags分流正确
packages/runtime/src/middleware.ts:authStage:- 根据
command.auth解析 credential 并注入ctx.client settings.dryRun下是否允许缺 credential 的策略明确
- 根据
packages/runtime/src/error-handler.ts:- AUTH hint 增强使用
binName,不要硬编码bl - URL 从
packages/runtime/src/urls.tsimport
- AUTH hint 增强使用
C. command 层
packages/commands/src/commands/auth/login.ts:- 新增/调整登录 flag 与流程
- 持久化只走
ctx.authStore().login(...)
packages/commands/src/commands/auth/status.ts:- 分别显示 model / console 鉴权状态,并 mask token
packages/commands/src/commands/auth/logout.ts:- 清理范围与双凭证并存规则一致
- 新的业务命令设置正确
auth:- 模型域请求 →
auth: "apiKey" - Console Gateway →
auth: "console" - 本地/登录/配置 →
auth: "none"
- 模型域请求 →
D. 用户面文档
README.md/README.zh.md"Authentication" 段落skills/bailian-cli/reference/通过pnpm run sync:skill-assets重建
E. 测试
packages/cli/tests/e2e/auth.e2e.test.ts增加新方式的 happy / failure 路径- mask token 的输出格式不变(避免泄漏)
- 如调整 resolver 优先级,补 core/runtime 单测覆盖 flag > env > file
完成后自查
# 各种凭证组合
unset DASHSCOPE_API_KEY DASHSCOPE_ACCESS_TOKEN
HOME=/tmp/empty node packages/cli/src/main.ts auth status
# flag 注入
node packages/cli/src/main.ts auth status --api-key sk-xxx
# env 注入
DASHSCOPE_API_KEY=sk-xxx node packages/cli/src/main.ts auth status
Console 登录/网关相关改动:
node packages/cli/src/main.ts auth login --console
node packages/cli/src/main.ts usage stats --dry-run --output json
常见漏点
- ✗ 加了新 token 来源但忘了改 resolver 优先级,实际不生效
- ✗
ConfigFile/Settings加字段但parseConfigFile或buildSettings没读 - ✗
auth login写成功但auth status不识别(两边走的 storage path 不一致) - ✗ token mask 显示完整 token,日志泄漏
- ✗
auth: "console"命令误用apiKey域,config 只有 API key 时会把sk-...发到网关 - ✗ 新增 core resolver hint 时写死产品命令,导致
rag等入口提示错误