Function GetSSHClient

backend/plugin/db/util/ssh.go:17–50

GetSSHClient returns a ssh client.

(ds *storepb.DataSource)

// GetSSHClient returns a ssh client.
func GetSSHClient(ds *storepb.DataSource) (*ssh.Client, error) {
	sshConfig := &ssh.ClientConfig{
		User:            ds.GetSshUser(),
		Auth:            []ssh.AuthMethod{},
		HostKeyCallback: ssh.InsecureIgnoreHostKey(),
	}
	if ds.GetSshPrivateKey() != "" {
		signer, err := ssh.ParsePrivateKey([]byte(ds.GetSshPrivateKey()))
		if err != nil {
			return nil, err
		}
		sshConfig.Auth = append(sshConfig.Auth, ssh.PublicKeys(signer))
	} else {
		// Users may use ssh-agent to store the private key with passphrase,
		// we will try to connect to the ssh-agent to get the private key.
		if conn, err := net.Dial("unix", os.Getenv("SSH_AUTH_SOCK")); err == nil {
			defer conn.Close()
			agentClient := agent.NewClient(conn)
			sshConfig.Auth = append(sshConfig.Auth, ssh.PublicKeysCallback(agentClient.Signers))
		}
	}
	// When there's a non empty password add the password AuthMethod.
	if ds.GetSshPassword() != "" {
		sshConfig.Auth = append(sshConfig.Auth, ssh.PasswordCallback(func() (string, error) {
			return ds.GetSshPassword(), nil
		}))
	}
	// Connect to the SSH Server
	sshConn, err := ssh.Dial("tcp", fmt.Sprintf("%s:%s", ds.GetSshHost(), ds.GetSshPort()), sshConfig)
	if err != nil {
		return nil, err
	}
	return sshConn, nil
}

const sshPortSize = 100