如何让Golang自定义SSH服务器支持VS Code Remote连接？

问题根源 #

VS Code Remote SSH扩展依赖SSH会话输出的干净、可解析格式提取远程端口等关键信息。当自定义SSH服务器转发的bash带有初始化输出（比如.bashrc/.profile的欢迎信息、提前输出的提示符），或未正确传递必要环境变量时，扩展会因无法解析端口抛出错误。

具体修复方案 #

1. 禁用bash初始化脚本输出 #

启动bash时添加--noprofile --norc参数，避免加载全局和用户初始化脚本，消除多余输出干扰解析：

cmd := exec.Command("docker", "exec", "-it", "nongpu_sam_test_sshd_container", "bash", "--noprofile", "--norc")

2. 传递SSH会话的终端环境变量 #

将SSH会话中的TERM变量传递给容器内bash，确保终端类型匹配，避免VS Code解析终端输出出错：

// 从SSH会话中提取TERM变量，兜底默认值
term := "xterm-256color"
for _, env := range s.Environ() {
    if len(env) >= 5 && env[:5] == "TERM=" {
        term = env[5:]
        break
    }
}
cmd := exec.Command("docker", "exec", "-it", "-e", "TERM="+term, "nongpu_sam_test_sshd_container", "bash", "--noprofile", "--norc")

3. 优化PTY窗口大小同步逻辑 #

为原窗口大小同步逻辑增加错误处理，避免goroutine panic中断会话：

go func() {
    for win := range winCh {
        if err := setWinsize(f, win.Width, win.Height); err != nil {
            log.Printf("Failed to set winsize: %v", err)
        }
    }
}()

4. 确保命令请求的无干扰响应 #

VS Code Remote会在连接后执行探测命令（如检查shell类型、获取环境信息），不要拦截或修改这些命令的输出，保证会话能正常响应。

修改后的完整代码 #

import (
    "io"
    "log"
    "os"
    "os/exec"
    "syscall"
    "unsafe"

    "github.com/creack/pty"
    "github.com/gliderlabs/ssh"
)

func setWinsize(f *os.File, w, h int) error {
    _, _, errno := syscall.Syscall(syscall.SYS_IOCTL, f.Fd(), uintptr(syscall.TIOCSWINSZ),
        uintptr(unsafe.Pointer(&struct{ h, w, x, y uint16 }{uint16(h), uint16(w), 0, 0})))
    if errno != 0 {
        return errno
    }
    return nil
}

func main() {
    ssh.Handle(func(s ssh.Session) {
        // 获取TERM环境变量，确保终端类型正确
        term := "xterm-256color"
        for _, env := range s.Environ() {
            if len(env) >= 5 && env[:5] == "TERM=" {
                term = env[5:]
                break
            }
        }

        // 启动容器内的bash，禁用初始化脚本并传递TERM变量
        cmd := exec.Command("docker", "exec", "-it", "-e", "TERM="+term, "nongpu_sam_test_sshd_container", "bash", "--noprofile", "--norc")
        _, winCh, _ := s.Pty()
        
        f, err := pty.Start(cmd)
        if err != nil {
            log.Printf("Failed to start PTY: %v", err)
            s.Exit(1)
            return
        }
        defer f.Close()

        // 同步窗口大小
        go func() {
            for win := range winCh {
                if err := setWinsize(f, win.Width, win.Height); err != nil {
                    log.Printf("Winsize sync failed: %v", err)
                }
            }
        }()

        // 双向复制IO
        go func() {
            _, err := io.Copy(f, s)
            if err != nil && err != io.EOF {
                log.Printf("Stdin copy failed: %v", err)
            }
        }()
        _, err = io.Copy(s, f)
        if err != nil && err != io.EOF {
            log.Printf("Stdout copy failed: %v", err)
        }

        cmd.Wait()
    })

    log.Fatal(ssh.ListenAndServe(":2217", nil))
}

验证步骤 #

1. 重新编译并启动SSH服务器
2. 在VS Code中使用Remote SSH连接localhost:2217
3. 若仍有问题，可开启VS Code的Remote SSH日志（设置中搜索Remote.SSH: Log Level设为Trace），查看具体解析失败点后针对性调整

内容的提问来源于stack exchange，提问作者samlhuillier