Go SSH连接Cisco设备：Pty优化解决长命令问题

本文详细阐述了使用Go语言SSH库连接Cisco设备时，发送长命令可能出现的截断问题及其解决方案。通过分析Go SSH `RequestPty` 函数的参数配置，揭示了终端宽度设置不当是导致命令被错误分割的根本原因，并提供了正确的Pty尺寸配置方法，确保长命令能够完整无误地发送和执行。

使用Go SSH库连接Cisco设备

在使用Go语言进行网络设备自动化管理时，SSH是与Cisco等设备交互的常用协议。通常，我们需要通过SSH建立连接，然后模拟终端会话，发送show命令来获取设备状态或配置信息。Go的golang.org/x/crypto/ssh库提供了强大的功能来实现这一点。

一个典型的SSH连接及会话建立流程如下：

1. 配置SSH客户端： 设置用户名、认证方式（密码或密钥）、主机密钥回调等。
2. 建立连接： 使用ssh.Dial函数连接到目标设备。
3. 创建会话： 从客户端创建新的SSH会话。
4. 获取I/O管道： 获取会话的标准输入（StdinPipe）和标准输出（StdoutPipe），用于发送命令和接收响应。
5. 请求伪终端（PTY）： 这是模拟交互式终端的关键步骤，它定义了终端类型、尺寸等。
6. 启动Shell： 在会话中启动一个远程Shell。

以下是Go语言实现这些步骤的基本代码结构：

package main

import (
    "fmt"
    "io"
    "log"
    "strings"
    "time"

    "golang.org/x/crypto/ssh"
)

// readUntilPrompt 从SSH输出中读取数据直到遇到指定提示符
func readUntilPrompt(reader io.Reader, prompt string) (string, error) {
    var output strings.Builder
    buf := make([]byte, 1024)
    for {
        n, err := reader.Read(buf)
        if err != nil {
            return "", fmt.Errorf("error reading from sshOut: %v", err)
        }
        output.Write(buf[:n])
        if strings.Contains(output.String(), prompt) {
            break
        }
    }
    return output.String(), nil
}

func main() {
    // 1. SSH配置
    config := &ssh.ClientConfig{
        User: "your_username",
        Auth: []ssh.AuthMethod{
            ssh.Password("your_password"),
        },
        HostKeyCallback: ssh.InsecureHostKeyCallback, // 生产环境请使用更安全的HostKeyCallback
        Timeout:         5 * time.Second,
    }

    // 2. 建立SSH连接
    client, err := ssh.Dial("tcp", "172.16.32.95:22", config)
    if err != nil {
        log.Fatalf("Failed to dial: %v", err)
    }
    defer client.Close()

    // 3. 创建新的会话
    session, err := client.NewSession()
    if err != nil {
        log.Fatalf("Failed to create session: %v", err)
    }
    defer session.Close()

    // 4. 获取标准输入输出管道
    sshOut, err := session.StdoutPipe()
    if err != nil {
        log.Fatalf("Failed to get stdout pipe: %v", err)
    }
    sshIn, err := session.StdinPipe()
    if err != nil {
        log.Fatalf("Failed to get stdin pipe: %v", err)
    }

    // 5. 请求伪终端 (PTY) - 初始配置（可能导致问题）
    modes := ssh.TerminalModes{
        ssh.ECHO:          0,     // 禁用回显
        ssh.TTY_OP_ISPEED: 14400, // input speed = 14.4kbaud
        ssh.TTY_OP_OSPEED: 14400, // output speed = 14.4kbaud
    }
    // 注意：这里的 width 参数可能过小
    if err := session.RequestPty("xterm", 80, 40, modes); err != nil { // height=80, width=40
        log.Fatalf("Request for pseudo terminal failed: %v", err)
    }

    // 6. 启动Shell
    if err := session.Shell(); err != nil {
        log.Fatalf("Failed to start shell: %v", err)
    }

    // 读取初始欢迎信息和提示符
    initialOutput, err := readUntilPrompt(sshOut, "[local]ewag#")
    if err != nil {
        log.Fatalf("Failed to read initial prompt: %v", err)
    }
    fmt.Println("--- Initial Output ---")
    fmt.Println(initialOutput)

    // 发送短命令示例
    commandShort := "show clock\r"
    fmt.Printf("--- Sending command: %s ---\n", strings.TrimSpace(commandShort))
    if _, err := sshIn.Write([]byte(commandShort)); err != nil {
        log.Fatalf("Failed to write command: %v", err)
    }
    responseShort, err := readUntilPrompt(sshOut, "[local]ewag#")
    if err != nil {
        log.Fatalf("Failed to read short command response: %v", err)
    }
    fmt.Println(responseShort)

    // ... 更多操作 ...
}

在上述代码中，session.RequestPty("xterm", 80, 40, modes)这行代码是关键，它请求一个伪终端，并指定了终端类型为xterm，高度为80行，宽度为40列。

长命令截断问题

当使用上述配置发送较短的命令（例如show clock）时，通常不会出现问题，命令能够被完整执行并返回结果。然而，当尝试发送一个较长的命令时，例如show session progress ipsg-service ipsg-gprs-svc，可能会观察到命令在远程设备上被意外截断，导致设备识别为未知命令或语法错误。

以下是截断问题的典型输出示例：

Last login: Tue Jan 14 18:09:19 -0500 2014 on pts/2 from 10.7.7.14.
Cisco Systems SSI
[local]ewag# 
show session progress ipsg
-service ipsg-gprs-svc
Unknown command - "ipsg-service", unrecognized keyword
[local]ewag# 

从输出中可以看出，发送的命令show session progress ipsg-service ipsg-gprs-svc在ipsg之后被分割成了两部分。这使得Cisco设备无法正确识别完整的命令，从而报错。

问题根源：PTY宽度配置不当

这个问题的根本原因在于session.RequestPty函数中伪终端的宽度（width）参数设置过小。session.RequestPty函数的签名是RequestPty(term string, h, w int, termmodes TerminalModes)，其中h代表终端高度，w代表终端宽度。

当我们将终端宽度设置为一个较小的值（例如40列）时，Go SSH库在模拟终端行为时，可能会在客户端侧对发送的命令进行“换行”处理，以适应这个较小的终端宽度。这意味着，即使我们通过sshIn.Write发送了一个完整的长字符串，SSH客户端在将其传输到远程服务器之前，可能已经根据PTY的宽度限制将其分割成了多行。远程Cisco设备接收到的就是这些被分割的命令片段，而不是一个完整的命令。

解决方案：优化PTY宽度配置

解决这个问题的关键是确保为伪终端配置一个足够大的宽度，或者让远程服务器决定其宽度。

根据实际测试，将PTY宽度设置为一个较大的值（例如200），同时可以将高度设置为0（让服务器决定或使用默认值），可以有效解决命令截断问题。

将原有的Pty请求：

if err := session.RequestPty("xterm", 80, 40, modes); err != nil { // height=80, width=40
    log.Fatalf("Request for pseudo terminal failed: %v", err)
}

修改为：

// 正确配置：增加宽度，将高度设置为0
if err := session.RequestPty("vt100", 0, 200, modes); err != nil { // height=0, width=200
    log.Fatalf("Request for pseudo terminal failed: %v", err)
}

修改后的代码片段：

// ... (之前的连接和会话建立代码) ...

// 重新配置并启动会话以应用新的PTY配置
// 注意：PTY只能请求一次，如果要在同一会话中更改，需要重新创建会话或连接
// 假设这里是为了演示，我们重新创建了一个会话
sessionFixed, err := client.NewSession() // 使用同一个client
if err != nil {
    log.Fatalf("Failed to create new session for fix: %v", err)
}
defer sessionFixed.Close()

sshOutFixed, err := sessionFixed.StdoutPipe()
if err != nil {
    log.Fatalf("Failed to get stdout pipe for fix: %v", err)
}
sshInFixed, err := sessionFixed.StdinPipe()
if err != nil {
    log.Fatalf("Failed to get stdin pipe for fix: %v", err)
}

// 优化