Golang通过SSH实现远程执行和SCP文件下载的插件库easyssh-proxy的使用

easyssh-proxy提供了Go语言中SSH协议功能的简单实现。

功能特性

这个项目是从easyssh分叉而来，但添加了以下功能：

• 支持用户私钥的纯文本
• 支持用户私钥的路径
• 支持TCP连接建立的超时设置
• 支持SSH ProxyCommand

使用示例

MakeConfig

所有功能都通过MakeConfig结构体的方法访问：

ssh := &easyssh.MakeConfig{
    User:    "drone-scp",
    Server:  "localhost",
    KeyPath: "./tests/.ssh/id_rsa",
    Port:    "22",
    Timeout: 60 * time.Second,
}

stdout, stderr, done, err := ssh.Run("ls -al", 60*time.Second)
err = ssh.Scp("/root/source.csv", "/tmp/target.csv")
stdoutChan, stderrChan, doneChan, errChan, err = ssh.Stream("for i in {1..5}; do echo ${i}; sleep 1; done; exit 2;", 60*time.Second)

SSH远程执行命令

package main

import (
  "fmt"
  "time"

  "github.com/appleboy/easyssh-proxy"
)

func main() {
  // 创建MakeConfig实例，包含远程用户名、服务器地址和私钥路径
  ssh := &easyssh.MakeConfig{
    User:   "appleboy",
    Server: "example.com",
    // 可选密钥或密码，如果两者都没有，我们会尝试联系您的代理SOCKET
    // Password: "password",
    // 粘贴您的私钥源内容
    // Key: `-----BEGIN RSA PRIVATE KEY-----
    // MIIEpAIBAAKCAQEA4e2D/qPN08pzTac+a8ZmlP1ziJOXk45CynMPtva0rtK/RB26
    // 7XC9wlRna4b3Ln8ew3q1ZcBjXwD4ppbTlmwAfQIaZTGJUgQbdsO9YA==
    // -----END RSA PRIVATE KEY-----
    // `,
    KeyPath: "/Users/username/.ssh/id_rsa",
    Port:    "22",
    Timeout: 60 * time.Second,

    // 使用密码短语解析私钥
    Passphrase: "1234",

    // 可选指纹SHA256验证
    // 获取指纹: ssh.FingerprintSHA256(key)
    // Fingerprint: "SHA256:mVPwvezndPv/ARoIadVY98vAC0g+P/5633yTC4d/wXE"

    // 启用不安全密码和密钥交换方法的使用
    // 这将启用以下不安全密码和密钥交换方法:
    // - aes128-cbc
    // - aes192-cbc
    // - aes256-cbc
    // - 3des-cbc
    // - diffie-hellman-group-exchange-sha256
    // - diffie-hellman-group-exchange-sha1
    // 这些算法不安全，可能允许攻击者恢复明文数据
    // UseInsecureCipher: true,
  }

  // 调用Run方法执行您想在远程服务器上运行的命令
  stdout, stderr, done, err := ssh.Run("ls -al", 60*time.Second)
  // 处理错误
  if err != nil {
    panic("Can't run remote command: " + err.Error())
  } else {
    fmt.Println("don is :", done, "stdout is :", stdout, ";   stderr is :", stderr)
  }
}

SCP文件传输

package main

import (
  "fmt"

  "github.com/appleboy/easyssh-proxy"
)

func main() {
  // 创建MakeConfig实例，包含远程用户名、服务器地址和私钥路径
  ssh := &easyssh.MakeConfig{
    User:     "appleboy",
    Server:   "example.com",
    Password: "123qwe",
    Port:     "22",
  }

  // 调用Scp方法上传文件到远程服务器
  // 请确保`tmp`文件夹存在
  err := ssh.Scp("/root/source.csv", "/tmp/target.csv")

  // 处理错误
  if err != nil {
    panic("Can't run remote command: " + err.Error())
  } else {
    fmt.Println("success")
  }
}

SSH ProxyCommand

ssh := &easyssh.MakeConfig{
    User:    "drone-scp",
    Server:  "localhost",
    Port:    "22",
    KeyPath: "./tests/.ssh/id_rsa",
    Timeout: 60 * time.Second,
    Proxy: easyssh.DefaultConfig{
      User:    "drone-scp",
      Server:  "localhost",
      Port:    "22",
      KeyPath: "./tests/.ssh/id_rsa",
      Timeout: 60 * time.Second,
    },
}

注意：Proxy连接的属性不会从跳板机继承。您必须在DefaultConfig结构体中明确指定它们。

SSH Stream日志

func main() {
  // 创建MakeConfig实例，包含远程用户名、服务器地址和私钥路径
  ssh := &easyssh.MakeConfig{
    Server:  "localhost",
    User:    "drone-scp",
    KeyPath: "./tests/.ssh/id_rsa",
    Port:    "22",
    Timeout: 60 * time.Second,
  }

  // 调用Run方法执行您想在远程服务器上运行的命令
  stdoutChan, stderrChan, doneChan, errChan, err := ssh.Stream("for i in {1..5}; do echo ${i}; sleep 1; done; exit 2;", 60*time.Second)
  // 处理错误
  if err != nil {
    panic("Can't run remote command: " + err.Error())
  } else {
    // 从输出通道读取，直到收到完成信号
    isTimeout := true
  loop:
    for {
      select {
      case isTimeout = <-doneChan:
        break loop
      case outline := <-stdoutChan:
        fmt.Println("out:", outline)
      case errline := <-stderrChan:
        fmt.Println("err:", errline)
      case err = <-errChan:
      }
    }

    // 获取退出代码或命令错误
    if err != nil {
      fmt.Println("err: " + err.Error())
    }

    // 命令超时
    if !isTimeout {
      fmt.Println("Error: command timeout")
    }
  }
}