@hyzyn/dsh-tty 0.17.2 → 0.18.1

package/lib/index.d.ts

@@ -50,7 +50,8 @@
  * OSC 133/7 钩子（zsh ZDOTDIR 桩 / bash --rcfile 桩），输出流解析出命令
  * 边界（tty_capture{last} / tty_expect 早停）与实时 cwd（tty_list）。
  * 辅助路由：/api/dsh-tty/ssh-config（~/.ssh/config 导入候选）、
- * /api/dsh-tty/env-vars（SSH 对话框 env:VAR 下拉，仅变量名）、
+ * /api/dsh-tty/credential-refs（凭据存储里已知的引用名，SSH 对话框选择器候选，只要名字）、
+ * /api/dsh-tty/env-vars（env 插件托管变量名；SSH 对话框已改从连接簿 + 凭据存储取候选，此路由保留兼容）、
  * /api/dsh-tty/shells（设置卡片「Shell 路径」候选，仅路径）、
  * /api/dsh-tty/sftp/*（SFTP 文件传输 0.7.0：list/mkdir/rename/remove/
  * download/upload；0.8.0 起 mkdir 支持 parents 逐级补齐，spec 解析与

package/lib/index.js

@@ -14,9 +14,9 @@ import xtermHeadless from '@xterm/headless';
 const HeadlessTerminal = xtermHeadless.Terminal;
 import { definePlugin } from '@hyzyn/dsh-kit';
 import { defineTool } from '@deepseek-ai/dsh-tools';
-import { spawnSsh, sshTarget, expandHome } from './ssh.js';
+import { spawnSsh, sshTarget, expandHome, setCredentialResolver } from './ssh.js';
 import { probeSsh } from './probe.js';
-import { buildCommandSpawn, buildShellSpawn } from './shell-integration.js';
+import { buildCommandSpawn, buildShellSpawn, defaultShellPath } from './shell-integration.js';
 import { parseSshConfig } from './ssh-config.js';
 import { parseKnownHosts } from './known-hosts.js';
 import { TunnelManager } from './tunnels.js';
@@ -1664,9 +1664,55 @@ function readManagedEnvKeys() {
     }
 }
 /**
- * 设置卡片「Shell 路径」候选（可选可输入的数据源）：/etc/shells + $SHELL +
- * 常见安装路径，去重后过滤「存在且可执行」，$SHELL 排最前。只回路径，
- * 不做任何执行。
+ * 凭据存储里**已知的引用名**（~/.dsh/.credentials.yaml 的 `refs:` 块键），只读给
+ * SSH 对话框的引用选择器当候选。
+ *
+ * 为什么必须读文件：官方把「引用半边」设计成**不可枚举**——
+ * `CredentialProvider.listRecords` 的注释原话是 "Unlike the reference half, which has no
+ * enumeration because configuration surfaces learn which references exist from settings
+ * schemas"，而浏览器侧 `ctx.remote.credentials`（dsh-api-settings-controller）只开
+ * `describe` / `set` / `unset`，连 `listRecords` 都没开。所以要让用户在下拉里看见
+ * "这本存储里已经有什么名字"，宿主侧读文件是唯一出路；**只要键名、不取值**（值只在本函数
+ * 的局部 `lines` 里路过，不进任何返回值，也不写日志）。
+ *
+ * 解析刻意最小（与上面 readManagedEnvKeys 同款，不为它引 YAML 依赖）：只认 `refs:` 顶层
+ * 区块内「恰好两个空格 + POSIX 标识符 + 冒号」的行。本地 provider 写入时用 `yaml` 严格
+ * 校验过（version: 1 / 值必须非空字符串 / 键必须是标识符），所以这个格式是稳的；真被手改
+ * 坏了也只是候选少几个 —— 引用最终仍由连接时的凭据层校验存在性。
+ *
+ * 路径解析与本地 provider 的默认一致（$DSH_HOME 优先，空串视为未设，再退 ~/.dsh）。边界：
+ * 若有人给 provider 配了自定义 `path` / `dshHome`，这里看不到那些引用（字段仍可手输名字）。
+ */
+function readCredentialRefNames() {
+    const dshHome = process.env.DSH_HOME?.trim() || join(homedir(), '.dsh');
+    const file = join(dshHome, '.credentials.yaml');
+    try {
+        const names = [];
+        let inRefs = false;
+        for (const line of readFileSync(file, 'utf8').split('\n')) {
+            // 顶层键（0 缩进）切换区块；`refs:` 之后的条目才是引用名
+            if (/^[A-Za-z_][A-Za-z0-9_]*:/.test(line)) {
+                inRefs = line.startsWith('refs:');
+                continue;
+            }
+            if (!inRefs)
+                continue;
+            const match = line.match(/^ {2}([A-Za-z_][A-Za-z0-9_]*):/);
+            if (match !== null)
+                names.push(match[1]);
+        }
+        return [...new Set(names)].sort().slice(0, 500);
+    }
+    catch {
+        // 没有存储文件（还没存过任何东西）/ 没有读权限：候选为空，不报错
+        return [];
+    }
+}
+/**
+ * 设置卡片「Shell 路径」候选（可选可输入的数据源）：POSIX 走 /etc/shells + $SHELL +
+ * 常见安装路径；**Windows 走 %COMSPEC% + Windows PowerShell + PowerShell 7**（原先这套
+ * 候选在 Windows 上恒为空——/bin/zsh 那批路径一个都不存在）。去重后过滤「存在且可执行」，
+ * 默认 shell 排最前。只回路径，不做任何执行。
  */
 function listCandidateShells() {
     const candidates = [];
@@ -1675,24 +1721,40 @@ function listCandidateShells() {
         if (path !== '' && !candidates.includes(path))
             candidates.push(path);
     };
-    try {
-        for (const line of readFileSync('/etc/shells', 'utf8').split('\n')) {
-            const path = line.trim();
-            if (path !== '' && !path.startsWith('#'))
-                push(path);
+    const fallback = defaultShellPath();
+    if (process.platform === 'win32') {
+        const systemRoot = process.env.SystemRoot?.trim() || 'C:\\Windows';
+        const programFiles = process.env.ProgramFiles?.trim() || 'C:\\Program Files';
+        const localAppData = process.env.LOCALAPPDATA?.trim() || '';
+        // 全给**绝对路径**：候选的过滤口径是「存在且可执行」，裸命令名（pwsh.exe）在这里判不了，
+        // 而这三处覆盖了 Windows 上实际存在的 shell（%COMSPEC% 必在，Windows PowerShell 必在，
+        // PowerShell 7 装了才有）。
+        push(process.env.COMSPEC);
+        push(join(systemRoot, 'System32', 'WindowsPowerShell', 'v1.0', 'powershell.exe'));
+        push(join(programFiles, 'PowerShell', '7', 'pwsh.exe'));
+        if (localAppData !== '')
+            push(join(localAppData, 'Microsoft', 'WindowsApps', 'pwsh.exe'));
+    }
+    else {
+        try {
+            for (const line of readFileSync('/etc/shells', 'utf8').split('\n')) {
+                const path = line.trim();
+                if (path !== '' && !path.startsWith('#'))
+                    push(path);
+            }
         }
+        catch {
+            /* 无 /etc/shells 时跳过 */
+        }
+        push(process.env.SHELL);
+        for (const path of [
+            '/bin/zsh', '/usr/bin/zsh', '/usr/local/bin/zsh', '/opt/homebrew/bin/zsh',
+            '/bin/bash', '/usr/bin/bash', '/usr/local/bin/bash', '/opt/homebrew/bin/bash',
+            '/bin/fish', '/usr/bin/fish', '/usr/local/bin/fish', '/opt/homebrew/bin/fish',
+            '/bin/sh', '/bin/dash', '/bin/ksh', '/bin/tcsh', '/bin/csh',
+        ])
+            push(path);
     }
-    catch {
-        /* 无 /etc/shells（如 Windows）时跳过 */
-    }
-    push(process.env.SHELL);
-    for (const path of [
-        '/bin/zsh', '/usr/bin/zsh', '/usr/local/bin/zsh', '/opt/homebrew/bin/zsh',
-        '/bin/bash', '/usr/bin/bash', '/usr/local/bin/bash', '/opt/homebrew/bin/bash',
-        '/bin/fish', '/usr/bin/fish', '/usr/local/bin/fish', '/opt/homebrew/bin/fish',
-        '/bin/sh', '/bin/dash', '/bin/ksh', '/bin/tcsh', '/bin/csh',
-    ])
-        push(path);
     const usable = candidates.filter((path) => {
         try {
             accessSync(path, fsConstants.X_OK);
@@ -1702,8 +1764,7 @@ function listCandidateShells() {
             return false;
         }
     });
-    const shell = process.env.SHELL?.trim() ?? '';
-    usable.sort((a, b) => (a === shell ? -1 : b === shell ? 1 : a.localeCompare(b)));
+    usable.sort((a, b) => (a === fallback ? -1 : b === fallback ? 1 : a.localeCompare(b)));
     return usable;
 }
 /**
@@ -1845,14 +1906,19 @@ const plugin = definePlugin({
         if (config?.enabled === false)
             return;
         const live = new LiveConfig({
-            shell: config?.shell?.trim() || process.env.SHELL || '/bin/zsh',
+            // 默认 shell 按平台取（Windows 没有 $SHELL，回落 /bin/zsh 会让本地终端一条都开不起来；
+            // 见 defaultShellPath）。用户显式填了「Shell 路径」就照用。
+            shell: config?.shell?.trim() || defaultShellPath(),
             term: config?.term?.trim() || 'xterm-256color',
             colorTerm: config?.colorTerm?.trim() || 'truecolor',
             cwd: config?.cwd?.trim() || process.cwd(),
             reconnectGraceSec: typeof config?.reconnectGraceSec === 'number' && Number.isInteger(config.reconnectGraceSec) && config.reconnectGraceSec >= 0 ? config.reconnectGraceSec : DEFAULT_RECONNECT_GRACE_SEC,
             sshHosts: Array.isArray(config?.sshHosts) ? config.sshHosts : [],
             hostKeys: Array.isArray(config?.hostKeys) ? config.hostKeys : [],
-            shellIntegration: config?.shellIntegration !== false,
+            // shell 集成（OSC 133/7）靠 POSIX rc 注入 + `-c` 包装层：Windows 上的 cmd / PowerShell
+            // 两者都不成立（实测 cmd 忽略 -c 空跑、PowerShell 报 export 不存在），所以恒关。
+            // 配置项照旧留着（快照里会显示 false），界面上也说明原因。
+            shellIntegration: process.platform !== 'win32' && config?.shellIntegration !== false,
             tunnels: Array.isArray(config?.tunnels) ? config.tunnels : [],
             persistence: config?.persistence === 'tmux' ? 'tmux' : 'off',
             endOnPageClose: config?.endOnPageClose === true,
@@ -1922,6 +1988,11 @@ const plugin = definePlugin({
             statsEnabled: live.statsEnabled,
             sftpLimits: live.sftpLimits,
             toolsRegistered: stateRef.toolsRegistered,
+            /**
+             * 宿主平台（`process.platform`）：客户端据此把「Shell 路径 / shell 集成」的说明与候选
+             * 按平台写（Windows 上不提 zsh/bash 那套，也不摆一个恒关闭的集成开关）。
+             */
+            platform: process.platform,
         });
         /** 规范化并应用一份配置补丁（settings/updated 事件与 HTTP POST 共用；幂等）。 */
         const applyPatch = (section) => {
@@ -2075,6 +2146,22 @@ const plugin = definePlugin({
             }
             return { patch };
         };
+        /*
+         * credentials（**可选**依赖）：连接簿里的 `env:NAME` 是**引用**，值归官方凭据 provider ——
+         * 它自己叠 `file`（`$DSH_HOME/.credentials.yaml`）/ `env` / `project-env` / `user-env` 各层，
+         * 并保证「每次操作重新解析」（改完下一个操作即生效，不必重启宿主）。
+         *
+         * 为什么必须走它：凭据存储里的值**永远不会 materialize 进环境**（provider README 原话），
+         * 所以只读 `process.env` 等于"存进凭据存储的密码连接时读不到" —— 「保存时存入凭据存储」
+         * 那条链此前就是断在这里（客户端那半切好了、宿主这半没切）。
+         *
+         * 服务缺失（老宿主 / 未装该 bundle）时不注册，`resolveSecret` 自己退回 `process.env`，行为与
+         * 从前一致 —— 所以这是**可选**依赖，不抬高 engines 下限。
+         */
+        ctx.inject(['credentials'], (credCtx) => {
+            setCredentialResolver(credCtx.credentials ?? null);
+            return () => { setCredentialResolver(null); };
+        });
         // webServer：WS upgrade 路由 + 配置读写路由（/api/dsh-tty/config）
         ctx.inject(['webServer'], (webCtx) => {
             webCtx.effect(() => {
@@ -2179,6 +2266,25 @@ const plugin = definePlugin({
                         writeJson(res, 200, { ok: true, names: readManagedEnvKeys() });
                     },
                 });
+                // 凭据存储里已知的引用名（SSH 对话框选择器候选）：只回**名字**，绝不回值。
+                // 为什么不像其它设置界面那样只列"自己 schema 里的引用"：官方那条路对这本存储
+                // 来说列不全（引用半边不可枚举，见 readCredentialRefNames），而这个选择器的用途
+                // 恰恰就是"我存过什么、能不能复用"。
+                registerGated({
+                    kind: 'exact',
+                    path: '/api/dsh-tty/credential-refs',
+                    handler: async (req, res) => {
+                        if (!isLoopbackHttp(req)) {
+                            writeJson(res, 403, { error: 'forbidden: loopback-only' });
+                            return;
+                        }
+                        if (req.method !== 'GET') {
+                            writeJson(res, 405, { error: 'method not allowed: ' + String(req.method) });
+                            return;
+                        }
+                        writeJson(res, 200, { ok: true, names: readCredentialRefNames() });
+                    },
+                });
                 // known_hosts 指纹导入候选（TOFU 预填充）：hashed 条目用连接簿主机名还原
                 registerGated({
                     kind: 'exact',