fix some error

README.md

@@ -11,6 +11,8 @@
 // rsync -av src  dst     ./src/* --> /root/dst/src/*  
 // rsync -av src  dst/    ./src/* --> /root/dst/src/*  
 
+## Install
+`go get github.com/pytool/ssh`
 ## Example
 
 ### 在远程执行ssh命令

auth.go

@@ -14,6 +14,23 @@ import (
 	"golang.org/x/crypto/ssh/terminal"
 )
 
+//HasAgent reports whether the SSH agent is available
+func HasAgent() bool {
+	authsock, ok := os.LookupEnv("SSH_AUTH_SOCK")
+	if !ok {
+		return false
+	}
+	if dirent, err := os.Stat(authsock); err != nil {
+		if os.IsNotExist(err) {
+			return false
+		}
+		if dirent.Mode()&os.ModeSocket == 0 {
+			return false
+		}
+	}
+	return true
+}
+
 // An implementation of ssh.KeyboardInteractiveChallenge that simply sends
 // back the password for all questions. The questions are logged.
 func passwordKeyboardInteractive(password string) ssh.KeyboardInteractiveChallenge {
@@ -48,7 +65,7 @@ func WithPassword(password string) (ssh.AuthMethod, error) {
 // WithAgent use already authed user
 func WithAgent() (ssh.AuthMethod, error) {
 	sock := os.Getenv("SSH_AUTH_SOCK")
-	if sock != "" {
+	if sock == "" {
 		// fmt.Println(errors.New("Agent Disabled"))
 		return nil, errors.New("Agent Disabled")
 	}
@@ -72,24 +89,29 @@ func WithAgent() (ssh.AuthMethod, error) {
 	// return nil
 }
 
-// WithPrivateKeys 设置多个 ~/.ssh/id_rsa
+// WithPrivateKeys 设置多个 ~/.ssh/id_rsa ,如果加密用passphrase尝试
-func WithPrivateKeys(keyFiles []string, password string) (ssh.AuthMethod, error) {
+func WithPrivateKeys(keyFiles []string, passphrase string) (ssh.AuthMethod, error) {
 	var signers []ssh.Signer
 
 	for _, key := range keyFiles {
 
-		buffer, err := ioutil.ReadFile(key)
+		pemBytes, err := ioutil.ReadFile(key)
 		if err != nil {
 			println(err.Error())
 			// return
 		}
-		signer, err := ssh.ParsePrivateKeyWithPassphrase([]byte(buffer), []byte(password))
+		signer, err := ssh.ParsePrivateKey([]byte(pemBytes))
 		if err != nil {
-			println(err.Error())
+			if strings.Contains(err.Error(), "cannot decode encrypted private keys") {
-		} else {
+				if signer, err = ssh.ParsePrivateKeyWithPassphrase(pemBytes, []byte(passphrase)); err != nil {
-			signers = append(signers, signer)
+					continue
 				}
 			}
+			// println(err.Error())
+		}
+		signers = append(signers, signer)
+
+	}
 	if signers == nil {
 		return nil, errors.New("WithPrivateKeys: no keyfiles input")
 	}
@@ -97,7 +119,7 @@ func WithPrivateKeys(keyFiles []string, password string) (ssh.AuthMethod, error)
 }
 
 // WithPrivateKey 自动监测是否带有密码
-func WithPrivateKey(keyfile string, password string) (ssh.AuthMethod, error) {
+func WithPrivateKey(keyfile string, passphrase string) (ssh.AuthMethod, error) {
 	pemBytes, err := ioutil.ReadFile(keyfile)
 	if err != nil {
 		println(err.Error())
@@ -108,13 +130,16 @@ func WithPrivateKey(keyfile string, password string) (ssh.AuthMethod, error) {
 	signer, err = ssh.ParsePrivateKey(pemBytes)
 	if err != nil {
 		if strings.Contains(err.Error(), "cannot decode encrypted private keys") {
-			if signer, err = ssh.ParsePrivateKeyWithPassphrase(pemBytes, []byte(password)); err == nil {
+			signer, err = ssh.ParsePrivateKeyWithPassphrase(pemBytes, []byte(passphrase))
+			if err == nil {
 				return ssh.PublicKeys(signer), nil
 			}
 		}
-	}
 		return nil, err
 	}
+	return ssh.PublicKeys(signer), nil
+
+}
 
 // WithPrivateKeyString 直接通过字符串
 func WithPrivateKeyString(key string, password string) (ssh.AuthMethod, error) {
@@ -134,27 +159,30 @@ func WithPrivateKeyString(key string, password string) (ssh.AuthMethod, error) {
 
 // WithPrivateKeyTerminal 通过终端读取带密码的 PublicKey
 func WithPrivateKeyTerminal(keyfile string) (ssh.AuthMethod, error) {
-	// fmt.Fprintf(os.Stderr, "This SSH key is encrypted. Please enter passphrase for key '%s':", priv.path)
-	passphrase, err := terminal.ReadPassword(int(syscall.Stdin))
-	if err != nil {
-		println(err.Error())
-		return nil, err
-	}
-
-	fmt.Fprintln(os.Stderr)
-
 	pemBytes, err := ioutil.ReadFile(keyfile)
 	if err != nil {
 
 		println(err.Error())
 		return nil, err
 	}
-	signer, err := ssh.ParsePrivateKeyWithPassphrase(pemBytes, passphrase)
-	if err != nil {
 
-		fmt.Println(err)
+	var signer ssh.Signer
+	signer, err = ssh.ParsePrivateKey(pemBytes)
+	if err != nil {
+		if strings.Contains(err.Error(), "cannot decode encrypted private keys") {
+
+			fmt.Fprintf(os.Stderr, "This SSH key is encrypted. Please enter passphrase for key '%s':", keyfile)
+			passphrase, err := terminal.ReadPassword(int(syscall.Stdin))
+			if err != nil {
+				// println(err.Error())
+				return nil, err
+			}
+			fmt.Fprintln(os.Stderr)
+			if signer, err = ssh.ParsePrivateKeyWithPassphrase(pemBytes, []byte(passphrase)); err == nil {
+				return ssh.PublicKeys(signer), nil
+			}
+		}
 		return nil, err
 	}
-
 	return ssh.PublicKeys(signer), nil
 }

client.go

@@ -2,6 +2,7 @@ package ssh
 
 import (
 	"errors"
+	"fmt"
 	"net"
 	"os"
 	"strconv"
@@ -19,58 +20,40 @@ type Client struct {
 	SFTPClient *sftp.Client
 }
 
-// NewClient 根据配置
-func NewClient(user, host, port, password string) (client *Client, err error) {
-	p, err := strconv.Atoi(port)
-	if err == nil || p == 0 {
-		p = 22
-	}
-	if user == "" {
-		user = "root"
-	}
-	var config = &Config{
-		User:     user,
-		Host:     host,
-		Port:     p,
-		Password: password,
-		// KeyFiles: []string{"~/.ssh/id_rsa"},
-	}
-	return New(config)
-}
-
 // New 创建SSH client
-func New(config *Config) (client *Client, err error) {
+func New(cnf *Config) (client *Client, err error) {
 	clientConfig := &ssh.ClientConfig{
-		User:            config.User,
+		User:            cnf.User,
 		Timeout:         DefaultTimeout,
 		HostKeyCallback: ssh.InsecureIgnoreHostKey(),
 	}
 
-	// 2. 密码方式
+	if cnf.Port == 0 {
-	if config.Password != "" {
+		cnf.Port = 22
-		clientConfig.Auth = append(clientConfig.Auth, ssh.Password(config.Password))
 	}
 
-	// 3. privite key file
+	// 1. privite key file
-	if len(config.KeyFiles) == 0 {
+	if len(cnf.KeyFiles) == 0 {
 		keyPath := os.Getenv("HOME") + "/.ssh/id_rsa"
-		if auth, err := WithPrivateKey(keyPath, config.Password); err != nil {
+		if auth, err := WithPrivateKey(keyPath, cnf.Passphrase); err == nil {
 			clientConfig.Auth = append(clientConfig.Auth, auth)
 		}
 	} else {
-		if auth, err := WithPrivateKeys(config.KeyFiles, config.Password); err != nil {
+		if auth, err := WithPrivateKeys(cnf.KeyFiles, cnf.Passphrase); err == nil {
 			clientConfig.Auth = append(clientConfig.Auth, auth)
 		}
 	}
-	// 1. agent
+	// 2. 密码方式 放在key之后,这样密钥失败之后可以使用Password方式
-	if auth, err := WithAgent(); err != nil {
+	if cnf.Password != "" {
+		clientConfig.Auth = append(clientConfig.Auth, ssh.Password(cnf.Password))
+	}
+	// 3. agent 模式放在最后,这样当前两者都不能使用时可以采用Agent模式
+	if auth, err := WithAgent(); err == nil {
 		clientConfig.Auth = append(clientConfig.Auth, auth)
 	}
-	if config.Port == 0 {
+
-		config.Port = 22
-	}
 	// hostPort := config.Host + ":" + strconv.Itoa(config.Port)
-	sshClient, err := ssh.Dial("tcp", net.JoinHostPort(config.Host, strconv.Itoa(config.Port)), clientConfig)
+	sshClient, err := ssh.Dial("tcp", net.JoinHostPort(cnf.Host, strconv.Itoa(cnf.Port)), clientConfig)
 
 	if err != nil {
 		return client, errors.New("Failed to dial ssh: " + err.Error())
@@ -85,15 +68,81 @@ func New(config *Config) (client *Client, err error) {
 	return &Client{SSHClient: sshClient, SFTPClient: sftpClient}, nil
 }
 
-// Execute cmd on the remote host and return stderr and stdout
+// NewClient 根据配置
-func (c *Client) Exec(cmd string) ([]byte, error) {
+func NewClient(host, port, user, password string) (client *Client, err error) {
-	session, err := c.SSHClient.NewSession()
+	p, _ := strconv.Atoi(port)
+	// if err != nil {
+	// 	p = 22
+	// }
+	if user == "" {
+		user = "root"
+	}
+	var config = &Config{
+		Host:     host,
+		Port:     p,
+		User:     user,
+		Password: password,
+		// KeyFiles: []string{"~/.ssh/id_rsa"},
+		Passphrase: password,
+	}
+	return New(config)
+}
+
+func NewWithAgent(Host, Port, User string) (client *Client, err error) {
+	clientConfig := &ssh.ClientConfig{
+		User:            User,
+		Timeout:         DefaultTimeout,
+		HostKeyCallback: ssh.InsecureIgnoreHostKey(),
+	}
+	auth, err := WithAgent()
 	if err != nil {
 		return nil, err
 	}
-	defer session.Close()
+	clientConfig.Auth = append(clientConfig.Auth, auth)
+	// hostPort := config.Host + ":" + strconv.Itoa(config.Port)
+	sshClient, err := ssh.Dial("tcp", net.JoinHostPort(Host, Port), clientConfig)
+
+	if err != nil {
+		return client, errors.New("Failed to dial ssh: " + err.Error())
+	}
+
+	// create sftp client
+	var sftpClient *sftp.Client
+	if sftpClient, err = sftp.NewClient(sshClient); err != nil {
+		return client, errors.New("Failed to conn sftp: " + err.Error())
+	}
+	return &Client{SSHClient: sshClient, SFTPClient: sftpClient}, nil
+
+}
+func NewWithPrivateKey(Host, Port, User, Passphrase string) (client *Client, err error) {
+	clientConfig := &ssh.ClientConfig{
+		User:            User,
+		Timeout:         DefaultTimeout,
+		HostKeyCallback: ssh.InsecureIgnoreHostKey(),
+	}
+	// 3. privite key file
+	keyPath := os.Getenv("HOME") + "/.ssh/id_rsa"
+	auth, err := WithPrivateKey(keyPath, Passphrase)
+	if err != nil {
+		fmt.Println(err)
+		return nil, err
+	}
+	clientConfig.Auth = append(clientConfig.Auth, auth)
+
+	// hostPort := config.Host + ":" + strconv.Itoa(config.Port)
+	sshClient, err := ssh.Dial("tcp", net.JoinHostPort(Host, Port), clientConfig)
+
+	if err != nil {
+		return client, errors.New("Failed to dial ssh: " + err.Error())
+	}
+
+	// create sftp client
+	var sftpClient *sftp.Client
+	if sftpClient, err = sftp.NewClient(sshClient); err != nil {
+		return client, errors.New("Failed to conn sftp: " + err.Error())
+	}
+	return &Client{SSHClient: sshClient, SFTPClient: sftpClient}, nil
 
-	return session.CombinedOutput(cmd)
 }
 
 // Close the underlying SSH connection
@@ -101,14 +150,3 @@ func (c *Client) Close() {
 	c.SFTPClient.Close()
 	c.SSHClient.Close()
 }
-
-func addPortToHost(host string) string {
-	_, _, err := net.SplitHostPort(host)
-
-	// We got an error so blindly try to add a port number
-	if err != nil {
-		return net.JoinHostPort(host, "22")
-	}
-
-	return host
-}

client_test.go

@@ -0,0 +1,52 @@
+package ssh
+
+import (
+	"fmt"
+	"testing"
+)
+
+func TestNewWithAgent(t *testing.T) {
+
+	c, err := NewWithAgent("118.190.117.250", "3009", "root")
+	if err != nil {
+		fmt.Println(err)
+		return
+	}
+	defer c.Close()
+	b, err := c.Run("id")
+	if err != nil {
+		fmt.Println(err)
+		return
+	}
+	fmt.Println(string(b))
+}
+
+func TestNewClient(t *testing.T) {
+	c, err := NewClient("192.168.5.154", "22", "root", "123456")
+	if err != nil {
+		fmt.Println(err)
+		return
+	}
+	defer c.Close()
+	b, err := c.Run("id")
+	if err != nil {
+		fmt.Println(err)
+		return
+	}
+	fmt.Println(string(b))
+}
+
+func TestNewWithPrivateKey(t *testing.T) {
+	c, err := NewWithPrivateKey("192.168.5.154", "22", "root", "123456")
+	if err != nil {
+		fmt.Println(err)
+		return
+	}
+	defer c.Close()
+	b, err := c.Run("id")
+	if err != nil {
+		fmt.Println(err)
+		return
+	}
+	fmt.Println(string(b))
+}

config.go

@@ -10,7 +10,9 @@ type Config struct {
 	Port       int
 	Password   string
 	KeyFiles   []string
+	Passphrase string
 
+	StickySession bool
 	// DisableAgentForwarding, if true, will not forward the SSH agent.
 	DisableAgentForwarding bool
 

ssh.go

@@ -0,0 +1,49 @@
+package ssh
+
+import (
+	"fmt"
+	"path/filepath"
+)
+
+// Run Execute cmd on the remote host and return stderr and stdout
+func (c *Client) Run(cmd string) ([]byte, error) {
+	session, err := c.SSHClient.NewSession()
+	if err != nil {
+		return nil, err
+	}
+	defer session.Close()
+
+	return session.CombinedOutput(cmd)
+}
+
+//Exec Execute cmd on the remote host and return stderr and stdout
+func (c *Client) Exec(cmd string) ([]byte, error) {
+	session, err := c.SSHClient.NewSession()
+	if err != nil {
+		return nil, err
+	}
+	defer session.Close()
+
+	return session.CombinedOutput(cmd)
+}
+
+// RunScript Executes a shell script file on the remote machine.
+// It is copied in the tmp folder and ran in a single session.
+// chmod +x is applied before running.
+// Returns an SshResponse and an error if any has occured
+func (c *Client) RunScript(scriptPath string) ([]byte, error) {
+	session, err := c.SSHClient.NewSession()
+	if err != nil {
+		return nil, err
+	}
+	defer session.Close()
+
+	// 1. 上传 script
+	remotePath := fmt.Sprintf("/tmp/%s", filepath.Base(scriptPath))
+	if err := c.UploadFile(scriptPath, remotePath); err != nil {
+		return nil, err
+	}
+	// 2. 执行script
+	rCmd := fmt.Sprintf("chmod +x %s ; %s", remotePath, remotePath)
+	return session.CombinedOutput(rCmd)
+}