zdpgo_ssh

README

zdpgo_ssh

使用Golang执行ssh命令

版本历史

• v1.0.3 2022/06/26 升级：日志组件升级
• v1.0.4 2022/06/26 新增：文件上传和下载
• v1.0.5 2022/06/26 优化：移除日志
• v1.0.6 2023/01/08 新增：通过公钥连接SSH，即就是免密登录

快速入门

执行shell命令

package main

import (
	"fmt"
	"github.com/zhangdapeng520/zdpgo_ssh"
)

func main() {
	// 创建对象
	s := zdpgo_ssh.NewWithConfig(&zdpgo_ssh.Config{
		Host:     "192.168.33.10",
		Port:     22,
		Username: "zhangdapeng",
		Password: "zhangdapeng",
	})

	// 进行连接
	output, err := s.Run("free -h")

	// 查看命令结果
	fmt.Printf("%v\n%v", output, err)

	// 查看健康状态
	fmt.Println(s.Status())
}

执行sudo命令

package main

import (
	"fmt"
	"github.com/zhangdapeng520/zdpgo_ssh"
)

func main() {
	s := zdpgo_ssh.NewWithConfig(&zdpgo_ssh.Config{
		Host:     "192.168.33.10",
		Port:     22,
		Username: "zhangdapeng",
		Password: "zhangdapeng",
	})
	output, err := s.Sudo("ls -lah")
	fmt.Printf("%v\n%v", output, err)
}

文件上传

package main

import (
	"fmt"
	"github.com/zhangdapeng520/zdpgo_ssh"
)

func main() {
	s := zdpgo_ssh.NewWithConfig(&zdpgo_ssh.Config{
		Host:     "192.168.33.10",
		Port:     22,
		Username: "zhangdapeng",
		Password: "zhangdapeng",
	})
	output, err := s.Sudo("ls -lah")
	fmt.Printf("%v\n%v", output, err)

	// 上传文件
	s.UploadFile("README.md", "README111.md")

	output, err = s.Sudo("ls -lah")
	fmt.Printf("%v\n%v", output, err)
}

文件下载

package main

import (
	"fmt"
	"github.com/zhangdapeng520/zdpgo_ssh"
)

func main() {
	s := zdpgo_ssh.NewWithConfig(&zdpgo_ssh.Config{
		Host:     "192.168.33.10",
		Port:     22,
		Username: "zhangdapeng",
		Password: "zhangdapeng",
	})
	output, err := s.Sudo("ls -lah")
	fmt.Printf("%v\n%v", output, err)

	// 下载文件
	s.DownloadFile("README111.md", "README111.md")

	output, err = s.Sudo("ls -lah")
	fmt.Printf("%v\n%v", output, err)
}

公共公钥连接SSH

Windows配置SSH免密登录

这一步很重要，大家可以自行谷歌解决。如果嫌麻烦，也可以关注我的公众号“Python私教”，里面有详细的配置教程和zdpgo_ssh库的使用说明。

使用示例

本示例的地址位于本开源项目的：examples/new_with_public_key/main.go

package main

import (
	"fmt"
	"github.com/zhangdapeng520/zdpgo_ssh"
)

func main() {
	var (
		user = "root"
		host = "192.168.1.81"
		port = 22
	)
	ssh, err := zdpgo_ssh.NewWithPublicKey(user, host, port)
	if err != nil {
		panic(err)
	}
	result, err := ssh.Run("pwd")
	if err != nil {
		panic(err)
	}
	fmt.Println(result)
}

Documentation

Index

• type Config
• type FileResult
• type SSH
  • func New() *SSH
  • func NewWithConfig(config *Config) *SSH
  • func NewWithPublicKey(user, host string, port int) (s *SSH, err error)
  • func (s *SSH) Connect() error
  • func (s *SSH) DownloadFile(remoteFileName, localFileName string) FileResult
  • func (ssh *SSH) FormatFileSize(s int64) (size string)
  • func (s *SSH) GetSshConfig() *ssh.ClientConfig
  • func (s *SSH) Run(command string) (string, error)
  • func (ssh *SSH) Status() bool
  • func (s *SSH) Sudo(command string) (string, error)
  • func (s *SSH) UploadFile(localFileName, remoteFileName string) FileResult

Types

type Config

type Config struct {
	Host     string `yaml:"host" json:"host"`
	Port     int    `yaml:"port" json:"port"`
	Username string `yaml:"username" json:"username"`
	Password string `yaml:"password" json:"password"`
}

type FileResult

type FileResult struct {
	Status         bool   `yaml:"status" json:"status"`
	LocalFileName  string `yaml:"local_file_name" json:"local_file_name"`
	LocalFileSize  uint64 `yaml:"local_file_size" json:"local_file_size"`
	RemoteFileName string `yaml:"remote_file_name" json:"remote_file_name"`
	RemoteFileSize uint64 `yaml:"remote_file_size" json:"remote_file_size"`
}

type SSH

type SSH struct {
	Client *ssh.Client // ssh客户端
	Config *Config
}

SSH SSH连接对象

func New

func New() *SSH

New 创建SSH对象 @param host 主机地址 @param username 用户名 @param password 密码 @param port 端口号,默认22

func NewWithConfig

func NewWithConfig(config *Config) *SSH

func NewWithPublicKey

func NewWithPublicKey(user, host string, port int) (s *SSH, err error)

NewWithPublicKey 通过公钥的方式连接 @param user 主机用户名 @param host 主机IP地址或域名 @param port 主机SSH服务端口号，一般是22 @return s SSH连接对象 @return err 错误信息

func (*SSH) Connect

func (s *SSH) Connect() error

Connect 建立连接

func (*SSH) DownloadFile

func (s *SSH) DownloadFile(remoteFileName, localFileName string) FileResult

DownloadFile 下载文件

func (*SSH) FormatFileSize

func (ssh *SSH) FormatFileSize(s int64) (size string)

FormatFileSize 字节的单位转换 保留两位小数

func (*SSH) GetSshConfig

func (s *SSH) GetSshConfig() *ssh.ClientConfig

GetSshConfig 获取SSH客户端配置

func (*SSH) Run

func (s *SSH) Run(command string) (string, error)

Run 执行sh命令 @param command 命令

func (*SSH) Status

func (ssh *SSH) Status() bool

Status 获取服务器的健康状态

func (*SSH) Sudo

func (s *SSH) Sudo(command string) (string, error)

Sudo 使用管理员身份执行sh命令 @param command 命令

func (*SSH) UploadFile

func (s *SSH) UploadFile(localFileName, remoteFileName string) FileResult

UploadFile 上传文件